Merged revisions 335078 via svnmerge from
[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  * \extref 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, void *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, 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         chan->tech = &console_tech;
423         ast_format_set(&chan->readformat, AST_FORMAT_SLINEAR16, 0);
424         ast_format_set(&chan->writeformat, AST_FORMAT_SLINEAR16, 0);
425         ast_format_cap_add(chan->nativeformats, &chan->readformat);
426         chan->tech_pvt = ref_pvt(pvt);
427
428         pvt->owner = chan;
429
430         if (!ast_strlen_zero(pvt->language))
431                 ast_string_field_set(chan, language, pvt->language);
432
433         ast_jb_configure(chan, &global_jbconf);
434
435         if (state != AST_STATE_DOWN) {
436                 if (ast_pbx_start(chan)) {
437                         chan->hangupcause = 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, void *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", (char *) 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 ? requestor->linkedid : 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 = c->tech_pvt;
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         c->tech_pvt = unref_pvt(pvt);
515
516         return 0;
517 }
518
519 static int console_answer(struct ast_channel *c)
520 {
521         struct console_pvt *pvt = c->tech_pvt;
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, char *dest, int timeout)
558 {
559         struct console_pvt *pvt = c->tech_pvt;
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(c->caller.id.name.valid, c->caller.id.name.str, ""),
565                 S_COR(c->caller.id.number.valid, c->caller.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 = chan->tech_pvt;
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 = chan->tech_pvt;
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 -1:
607                 res = -1;  /* Ask for inband indications */
608                 break;
609         case AST_CONTROL_PROGRESS:
610         case AST_CONTROL_PROCEEDING:
611         case AST_CONTROL_VIDUPDATE:
612         case AST_CONTROL_SRCUPDATE:
613                 break;
614         case AST_CONTROL_HOLD:
615                 ast_verb(1, V_BEGIN "Console Has Been Placed on Hold" V_END);
616                 ast_moh_start(chan, data, pvt->mohinterpret);
617                 break;
618         case AST_CONTROL_UNHOLD:
619                 ast_verb(1, V_BEGIN "Console Has Been Retrieved from Hold" V_END);
620                 ast_moh_stop(chan);
621                 break;
622         default:
623                 ast_log(LOG_WARNING, "Don't know how to display condition %d on %s\n", 
624                         cond, chan->name);
625                 /* The core will play inband indications for us if appropriate */
626                 res = -1;
627         }
628
629         return res;
630 }
631
632 static int console_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
633 {
634         struct console_pvt *pvt = newchan->tech_pvt;
635
636         pvt->owner = newchan;
637
638         return 0;
639 }
640
641 /*!
642  * split a string in extension-context, returns pointers to malloc'ed
643  * strings.
644  * If we do not have 'overridecontext' then the last @ is considered as
645  * a context separator, and the context is overridden.
646  * This is usually not very necessary as you can play with the dialplan,
647  * and it is nice not to need it because you have '@' in SIP addresses.
648  * Return value is the buffer address.
649  *
650  * \note came from chan_oss
651  */
652 static char *ast_ext_ctx(struct console_pvt *pvt, const char *src, char **ext, char **ctx)
653 {
654         if (ext == NULL || ctx == NULL)
655                 return NULL;                    /* error */
656
657         *ext = *ctx = NULL;
658
659         if (src && *src != '\0')
660                 *ext = ast_strdup(src);
661
662         if (*ext == NULL)
663                 return NULL;
664
665         if (!pvt->overridecontext) {
666                 /* parse from the right */
667                 *ctx = strrchr(*ext, '@');
668                 if (*ctx)
669                         *(*ctx)++ = '\0';
670         }
671
672         return *ext;
673 }
674
675 static struct console_pvt *get_active_pvt(void)
676 {
677         struct console_pvt *pvt;
678
679         ast_rwlock_rdlock(&active_lock);
680         pvt = ref_pvt(active_pvt);      
681         ast_rwlock_unlock(&active_lock);
682
683         return pvt;
684 }
685
686 static char *cli_console_autoanswer(struct ast_cli_entry *e, int cmd, 
687         struct ast_cli_args *a)
688 {
689         struct console_pvt *pvt = get_active_pvt();
690         char *res = CLI_SUCCESS;
691
692         switch (cmd) {
693         case CLI_INIT:
694                 e->command = "console {set|show} autoanswer [on|off]";
695                 e->usage =
696                         "Usage: console {set|show} autoanswer [on|off]\n"
697                         "       Enables or disables autoanswer feature.  If used without\n"
698                         "       argument, displays the current on/off status of autoanswer.\n"
699                         "       The default value of autoanswer is in 'oss.conf'.\n";
700                 return NULL;
701
702         case CLI_GENERATE:
703                 return NULL;
704         }
705
706         if (!pvt) {
707                 ast_cli(a->fd, "No console device is set as active.\n");
708                 return CLI_FAILURE;
709         }
710
711         if (a->argc == e->args - 1) {
712                 ast_cli(a->fd, "Auto answer is %s.\n", pvt->autoanswer ? "on" : "off");
713                 unref_pvt(pvt);
714                 return CLI_SUCCESS;
715         }
716
717         if (a->argc != e->args) {
718                 unref_pvt(pvt);
719                 return CLI_SHOWUSAGE;
720         }
721
722         if (!strcasecmp(a->argv[e->args-1], "on"))
723                 pvt->autoanswer = 1;
724         else if (!strcasecmp(a->argv[e->args - 1], "off"))
725                 pvt->autoanswer = 0;
726         else
727                 res = CLI_SHOWUSAGE;
728
729         unref_pvt(pvt);
730
731         return res;
732 }
733
734 static char *cli_console_flash(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
735 {
736         struct console_pvt *pvt = get_active_pvt();
737
738         if (cmd == CLI_INIT) {
739                 e->command = "console flash";
740                 e->usage =
741                         "Usage: console flash\n"
742                         "       Flashes the call currently placed on the console.\n";
743                 return NULL;
744         } else if (cmd == CLI_GENERATE)
745                 return NULL;
746
747         if (!pvt) {
748                 ast_cli(a->fd, "No console device is set as active\n");
749                 return CLI_FAILURE;
750         }
751
752         if (a->argc != e->args)
753                 return CLI_SHOWUSAGE;
754
755         if (!pvt->owner) {
756                 ast_cli(a->fd, "No call to flash\n");
757                 unref_pvt(pvt);
758                 return CLI_FAILURE;
759         }
760
761         pvt->hookstate = 0;
762
763         ast_queue_control(pvt->owner, AST_CONTROL_FLASH);
764
765         unref_pvt(pvt);
766
767         return CLI_SUCCESS;
768 }
769
770 static char *cli_console_dial(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
771 {
772         char *s = NULL;
773         const char *mye = NULL, *myc = NULL; 
774         struct console_pvt *pvt = get_active_pvt();
775
776         if (cmd == CLI_INIT) {
777                 e->command = "console dial";
778                 e->usage =
779                         "Usage: console dial [extension[@context]]\n"
780                         "       Dials a given extension (and context if specified)\n";
781                 return NULL;
782         } else if (cmd == CLI_GENERATE)
783                 return NULL;
784
785         if (!pvt) {
786                 ast_cli(a->fd, "No console device is currently set as active\n");
787                 return CLI_FAILURE;
788         }
789         
790         if (a->argc > e->args + 1)
791                 return CLI_SHOWUSAGE;
792
793         if (pvt->owner) {       /* already in a call */
794                 int i;
795                 struct ast_frame f = { AST_FRAME_DTMF };
796                 const char *s;
797
798                 if (a->argc == e->args) {       /* argument is mandatory here */
799                         ast_cli(a->fd, "Already in a call. You can only dial digits until you hangup.\n");
800                         unref_pvt(pvt);
801                         return CLI_FAILURE;
802                 }
803                 s = a->argv[e->args];
804                 /* send the string one char at a time */
805                 for (i = 0; i < strlen(s); i++) {
806                         f.subclass.integer = s[i];
807                         ast_queue_frame(pvt->owner, &f);
808                 }
809                 unref_pvt(pvt);
810                 return CLI_SUCCESS;
811         }
812
813         /* if we have an argument split it into extension and context */
814         if (a->argc == e->args + 1) {
815                 char *ext = NULL, *con = NULL;
816                 s = ast_ext_ctx(pvt, a->argv[e->args], &ext, &con);
817                 ast_debug(1, "provided '%s', exten '%s' context '%s'\n", 
818                         a->argv[e->args], mye, myc);
819                 mye = ext;
820                 myc = con;
821         }
822
823         /* supply default values if needed */
824         if (ast_strlen_zero(mye))
825                 mye = pvt->exten;
826         if (ast_strlen_zero(myc))
827                 myc = pvt->context;
828
829         if (ast_exists_extension(NULL, myc, mye, 1, NULL)) {
830                 console_pvt_lock(pvt);
831                 pvt->hookstate = 1;
832                 console_new(pvt, mye, myc, AST_STATE_RINGING, NULL);
833                 console_pvt_unlock(pvt);
834         } else
835                 ast_cli(a->fd, "No such extension '%s' in context '%s'\n", mye, myc);
836
837         free(s);
838
839         unref_pvt(pvt);
840
841         return CLI_SUCCESS;
842 }
843
844 static char *cli_console_hangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
845 {
846         struct console_pvt *pvt = get_active_pvt();
847
848         if (cmd == CLI_INIT) {
849                 e->command = "console hangup";
850                 e->usage =
851                         "Usage: console hangup\n"
852                         "       Hangs up any call currently placed on the console.\n";
853                 return NULL;
854         } else if (cmd == CLI_GENERATE)
855                 return NULL;
856
857         if (!pvt) {
858                 ast_cli(a->fd, "No console device is set as active\n");
859                 return CLI_FAILURE;
860         }
861         
862         if (a->argc != e->args)
863                 return CLI_SHOWUSAGE;
864
865         if (!pvt->owner && !pvt->hookstate) {
866                 ast_cli(a->fd, "No call to hang up\n");
867                 unref_pvt(pvt);
868                 return CLI_FAILURE;
869         }
870
871         pvt->hookstate = 0;
872         if (pvt->owner)
873                 ast_queue_hangup(pvt->owner);
874
875         unref_pvt(pvt);
876
877         return CLI_SUCCESS;
878 }
879
880 static char *cli_console_mute(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
881 {
882         const char *s;
883         struct console_pvt *pvt = get_active_pvt();
884         char *res = CLI_SUCCESS;
885
886         if (cmd == CLI_INIT) {
887                 e->command = "console {mute|unmute}";
888                 e->usage =
889                         "Usage: console {mute|unmute}\n"
890                         "       Mute/unmute the microphone.\n";
891                 return NULL;
892         } else if (cmd == CLI_GENERATE)
893                 return NULL;
894
895         if (!pvt) {
896                 ast_cli(a->fd, "No console device is set as active\n");
897                 return CLI_FAILURE;
898         }
899
900         if (a->argc != e->args)
901                 return CLI_SHOWUSAGE;
902
903         s = a->argv[e->args-1];
904         if (!strcasecmp(s, "mute"))
905                 pvt->muted = 1;
906         else if (!strcasecmp(s, "unmute"))
907                 pvt->muted = 0;
908         else
909                 res = CLI_SHOWUSAGE;
910
911         ast_verb(1, V_BEGIN "The Console is now %s" V_END, 
912                 pvt->muted ? "Muted" : "Unmuted");
913
914         unref_pvt(pvt);
915
916         return res;
917 }
918
919 static char *cli_list_available(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
920 {
921         PaDeviceIndex idx, num, def_input, def_output;
922
923         if (cmd == CLI_INIT) {
924                 e->command = "console list available";
925                 e->usage =
926                         "Usage: console list available\n"
927                         "       List all available devices.\n";
928                 return NULL;
929         } else if (cmd == CLI_GENERATE)
930                 return NULL;
931
932         if (a->argc != e->args)
933                 return CLI_SHOWUSAGE;
934
935         ast_cli(a->fd, "\n"
936                     "=============================================================\n"
937                     "=== Available Devices =======================================\n"
938                     "=============================================================\n"
939                     "===\n");
940
941         num = Pa_GetDeviceCount();
942         if (!num) {
943                 ast_cli(a->fd, "(None)\n");
944                 return CLI_SUCCESS;
945         }
946
947         def_input = Pa_GetDefaultInputDevice();
948         def_output = Pa_GetDefaultOutputDevice();
949         for (idx = 0; idx < num; idx++) {
950                 const PaDeviceInfo *dev = Pa_GetDeviceInfo(idx);
951                 if (!dev)
952                         continue;
953                 ast_cli(a->fd, "=== ---------------------------------------------------------\n"
954                                "=== Device Name: %s\n", dev->name);
955                 if (dev->maxInputChannels)
956                         ast_cli(a->fd, "=== ---> %sInput Device\n", (idx == def_input) ? "Default " : "");
957                 if (dev->maxOutputChannels)
958                         ast_cli(a->fd, "=== ---> %sOutput Device\n", (idx == def_output) ? "Default " : "");
959                 ast_cli(a->fd, "=== ---------------------------------------------------------\n===\n");
960         }
961
962         ast_cli(a->fd, "=============================================================\n\n");
963
964         return CLI_SUCCESS;
965 }
966
967 static char *cli_list_devices(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
968 {
969         struct ao2_iterator i;
970         struct console_pvt *pvt;
971
972         if (cmd == CLI_INIT) {
973                 e->command = "console list devices";
974                 e->usage =
975                         "Usage: console list devices\n"
976                         "       List all configured devices.\n";
977                 return NULL;
978         } else if (cmd == CLI_GENERATE)
979                 return NULL;
980
981         if (a->argc != e->args)
982                 return CLI_SHOWUSAGE;
983
984         ast_cli(a->fd, "\n"
985                     "=============================================================\n"
986                     "=== Configured Devices ======================================\n"
987                     "=============================================================\n"
988                     "===\n");
989
990         i = ao2_iterator_init(pvts, 0);
991         while ((pvt = ao2_iterator_next(&i))) {
992                 console_pvt_lock(pvt);
993
994                 ast_cli(a->fd, "=== ---------------------------------------------------------\n"
995                                "=== Device Name: %s\n"
996                                "=== ---> Active:           %s\n"
997                                "=== ---> Input Device:     %s\n"
998                                "=== ---> Output Device:    %s\n"
999                                "=== ---> Context:          %s\n"
1000                                "=== ---> Extension:        %s\n"
1001                                "=== ---> CallerID Num:     %s\n"
1002                                "=== ---> CallerID Name:    %s\n"
1003                                "=== ---> MOH Interpret:    %s\n"
1004                                "=== ---> Language:         %s\n"
1005                                "=== ---> Parkinglot:       %s\n"
1006                                "=== ---> Muted:            %s\n"
1007                                "=== ---> Auto-Answer:      %s\n"
1008                                "=== ---> Override Context: %s\n"
1009                                "=== ---------------------------------------------------------\n===\n",
1010                         pvt->name, (pvt == active_pvt) ? "Yes" : "No",
1011                         pvt->input_device, pvt->output_device, pvt->context,
1012                         pvt->exten, pvt->cid_num, pvt->cid_name, pvt->mohinterpret,
1013                         pvt->language, pvt->parkinglot, pvt->muted ? "Yes" : "No", pvt->autoanswer ? "Yes" : "No",
1014                         pvt->overridecontext ? "Yes" : "No");
1015
1016                 console_pvt_unlock(pvt);
1017                 unref_pvt(pvt);
1018         }
1019         ao2_iterator_destroy(&i);
1020
1021         ast_cli(a->fd, "=============================================================\n\n");
1022
1023         return CLI_SUCCESS;
1024 }
1025 /*!
1026  * \brief answer command from the console
1027  */
1028 static char *cli_console_answer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1029 {
1030         struct console_pvt *pvt = get_active_pvt();
1031
1032         switch (cmd) {
1033         case CLI_INIT:
1034                 e->command = "console answer";
1035                 e->usage =
1036                         "Usage: console answer\n"
1037                         "       Answers an incoming call on the console channel.\n";
1038                 return NULL;
1039
1040         case CLI_GENERATE:
1041                 return NULL;    /* no completion */
1042         }
1043
1044         if (!pvt) {
1045                 ast_cli(a->fd, "No console device is set as active\n");
1046                 return CLI_FAILURE;
1047         }
1048
1049         if (a->argc != e->args) {
1050                 unref_pvt(pvt);
1051                 return CLI_SHOWUSAGE;
1052         }
1053
1054         if (!pvt->owner) {
1055                 ast_cli(a->fd, "No one is calling us\n");
1056                 unref_pvt(pvt);
1057                 return CLI_FAILURE;
1058         }
1059
1060         pvt->hookstate = 1;
1061
1062         ast_indicate(pvt->owner, -1);
1063
1064         ast_queue_control(pvt->owner, AST_CONTROL_ANSWER);
1065
1066         unref_pvt(pvt);
1067
1068         return CLI_SUCCESS;
1069 }
1070
1071 /*!
1072  * \brief Console send text CLI command
1073  *
1074  * \note concatenate all arguments into a single string. argv is NULL-terminated
1075  * so we can use it right away
1076  */
1077 static char *cli_console_sendtext(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1078 {
1079         char buf[TEXT_SIZE];
1080         struct console_pvt *pvt = get_active_pvt();
1081         struct ast_frame f = {
1082                 .frametype = AST_FRAME_TEXT,
1083                 .data.ptr = buf,
1084                 .src = "console_send_text",
1085         };
1086         int len;
1087
1088         if (cmd == CLI_INIT) {
1089                 e->command = "console send text";
1090                 e->usage =
1091                         "Usage: console send text <message>\n"
1092                         "       Sends a text message for display on the remote terminal.\n";
1093                 return NULL;
1094         } else if (cmd == CLI_GENERATE)
1095                 return NULL;
1096
1097         if (!pvt) {
1098                 ast_cli(a->fd, "No console device is set as active\n");
1099                 return CLI_FAILURE;
1100         }
1101
1102         if (a->argc < e->args + 1) {
1103                 unref_pvt(pvt);
1104                 return CLI_SHOWUSAGE;
1105         }
1106
1107         if (!pvt->owner) {
1108                 ast_cli(a->fd, "Not in a call\n");
1109                 unref_pvt(pvt);
1110                 return CLI_FAILURE;
1111         }
1112
1113         ast_join(buf, sizeof(buf) - 1, a->argv + e->args);
1114         if (ast_strlen_zero(buf)) {
1115                 unref_pvt(pvt);
1116                 return CLI_SHOWUSAGE;
1117         }
1118
1119         len = strlen(buf);
1120         buf[len] = '\n';
1121         f.datalen = len + 1;
1122
1123         ast_queue_frame(pvt->owner, &f);
1124
1125         unref_pvt(pvt);
1126
1127         return CLI_SUCCESS;
1128 }
1129
1130 static void set_active(struct console_pvt *pvt, const char *value)
1131 {
1132         if (pvt == &globals) {
1133                 ast_log(LOG_ERROR, "active is only valid as a per-device setting\n");
1134                 return;
1135         }
1136
1137         if (!ast_true(value))
1138                 return;
1139
1140         ast_rwlock_wrlock(&active_lock);
1141         if (active_pvt)
1142                 unref_pvt(active_pvt);
1143         active_pvt = ref_pvt(pvt);
1144         ast_rwlock_unlock(&active_lock);
1145 }
1146
1147 static char *cli_console_active(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1148 {
1149         struct console_pvt *pvt;
1150
1151         switch (cmd) {
1152         case CLI_INIT:
1153                 e->command = "console {set|show} active";
1154                 e->usage =
1155                         "Usage: console {set|show} active [<device>]\n"
1156                         "       Set or show the active console device for the Asterisk CLI.\n";
1157                 return NULL;
1158         case CLI_GENERATE:
1159                 if (a->pos == e->args) {
1160                         struct ao2_iterator i;
1161                         int x = 0;
1162                         char *res = NULL;
1163                         i = ao2_iterator_init(pvts, 0);
1164                         while ((pvt = ao2_iterator_next(&i))) {
1165                                 if (++x > a->n && !strncasecmp(pvt->name, a->word, strlen(a->word)))
1166                                         res = ast_strdup(pvt->name);
1167                                 unref_pvt(pvt);
1168                                 if (res) {
1169                                         ao2_iterator_destroy(&i);
1170                                         return res;
1171                                 }
1172                         }
1173                         ao2_iterator_destroy(&i);
1174                 }
1175                 return NULL;
1176         }
1177
1178         if (a->argc < e->args)
1179                 return CLI_SHOWUSAGE;
1180
1181         if (a->argc == 3) {
1182                 pvt = get_active_pvt();
1183
1184                 if (!pvt)
1185                         ast_cli(a->fd, "No device is currently set as the active console device.\n");
1186                 else {
1187                         console_pvt_lock(pvt);
1188                         ast_cli(a->fd, "The active console device is '%s'.\n", pvt->name);
1189                         console_pvt_unlock(pvt);
1190                         pvt = unref_pvt(pvt);
1191                 }
1192
1193                 return CLI_SUCCESS;
1194         }
1195
1196         if (!(pvt = find_pvt(a->argv[e->args - 1]))) {
1197                 ast_cli(a->fd, "Could not find a device called '%s'.\n", a->argv[e->args]);
1198                 return CLI_FAILURE;
1199         }
1200
1201         set_active(pvt, "yes");
1202
1203         console_pvt_lock(pvt);
1204         ast_cli(a->fd, "The active console device has been set to '%s'\n", pvt->name);
1205         console_pvt_unlock(pvt);
1206
1207         unref_pvt(pvt);
1208
1209         return CLI_SUCCESS;
1210 }
1211
1212 static struct ast_cli_entry cli_console[] = {
1213         AST_CLI_DEFINE(cli_console_dial,       "Dial an extension from the console"),
1214         AST_CLI_DEFINE(cli_console_hangup,     "Hangup a call on the console"),
1215         AST_CLI_DEFINE(cli_console_mute,       "Disable/Enable mic input"),
1216         AST_CLI_DEFINE(cli_console_answer,     "Answer an incoming console call"),
1217         AST_CLI_DEFINE(cli_console_sendtext,   "Send text to a connected party"),
1218         AST_CLI_DEFINE(cli_console_flash,      "Send a flash to the connected party"),
1219         AST_CLI_DEFINE(cli_console_autoanswer, "Turn autoanswer on or off"),
1220         AST_CLI_DEFINE(cli_list_available,     "List available devices"),
1221         AST_CLI_DEFINE(cli_list_devices,       "List configured devices"),
1222         AST_CLI_DEFINE(cli_console_active,     "View or Set the active console device"),
1223 };
1224
1225 /*!
1226  * \brief Set default values for a pvt struct
1227  *
1228  * \note This function expects the pvt lock to be held.
1229  */
1230 static void set_pvt_defaults(struct console_pvt *pvt)
1231 {
1232         if (pvt == &globals) {
1233                 ast_string_field_set(pvt, mohinterpret, "default");
1234                 ast_string_field_set(pvt, context, "default");
1235                 ast_string_field_set(pvt, exten, "s");
1236                 ast_string_field_set(pvt, language, "");
1237                 ast_string_field_set(pvt, cid_num, "");
1238                 ast_string_field_set(pvt, cid_name, "");
1239                 ast_string_field_set(pvt, parkinglot, "");
1240         
1241                 pvt->overridecontext = 0;
1242                 pvt->autoanswer = 0;
1243         } else {
1244                 ast_mutex_lock(&globals_lock);
1245
1246                 ast_string_field_set(pvt, mohinterpret, globals.mohinterpret);
1247                 ast_string_field_set(pvt, context, globals.context);
1248                 ast_string_field_set(pvt, exten, globals.exten);
1249                 ast_string_field_set(pvt, language, globals.language);
1250                 ast_string_field_set(pvt, cid_num, globals.cid_num);
1251                 ast_string_field_set(pvt, cid_name, globals.cid_name);
1252                 ast_string_field_set(pvt, parkinglot, globals.parkinglot);
1253
1254                 pvt->overridecontext = globals.overridecontext;
1255                 pvt->autoanswer = globals.autoanswer;
1256
1257                 ast_mutex_unlock(&globals_lock);
1258         }
1259 }
1260
1261 static void store_callerid(struct console_pvt *pvt, const char *value)
1262 {
1263         char cid_name[256];
1264         char cid_num[256];
1265
1266         ast_callerid_split(value, cid_name, sizeof(cid_name), 
1267                 cid_num, sizeof(cid_num));
1268
1269         ast_string_field_set(pvt, cid_name, cid_name);
1270         ast_string_field_set(pvt, cid_num, cid_num);
1271 }
1272
1273 /*!
1274  * \brief Store a configuration parameter in a pvt struct
1275  *
1276  * \note This function expects the pvt lock to be held.
1277  */
1278 static void store_config_core(struct console_pvt *pvt, const char *var, const char *value)
1279 {
1280         if (pvt == &globals && !ast_jb_read_conf(&global_jbconf, var, value))
1281                 return;
1282
1283         CV_START(var, value);
1284
1285         CV_STRFIELD("context", pvt, context);
1286         CV_STRFIELD("extension", pvt, exten);
1287         CV_STRFIELD("mohinterpret", pvt, mohinterpret);
1288         CV_STRFIELD("language", pvt, language);
1289         CV_F("callerid", store_callerid(pvt, value));
1290         CV_BOOL("overridecontext", pvt->overridecontext);
1291         CV_BOOL("autoanswer", pvt->autoanswer);
1292         CV_STRFIELD("parkinglot", pvt, parkinglot);
1293
1294         if (pvt != &globals) {
1295                 CV_F("active", set_active(pvt, value))
1296                 CV_STRFIELD("input_device", pvt, input_device);
1297                 CV_STRFIELD("output_device", pvt, output_device);
1298         }
1299
1300         ast_log(LOG_WARNING, "Unknown option '%s'\n", var);
1301
1302         CV_END;
1303 }
1304
1305 static void pvt_destructor(void *obj)
1306 {
1307         struct console_pvt *pvt = obj;
1308
1309         ast_string_field_free_memory(pvt);
1310 }
1311
1312 static int init_pvt(struct console_pvt *pvt, const char *name)
1313 {
1314         pvt->thread = AST_PTHREADT_NULL;
1315
1316         if (ast_string_field_init(pvt, 32))
1317                 return -1;
1318
1319         ast_string_field_set(pvt, name, S_OR(name, ""));
1320
1321         return 0;
1322 }
1323
1324 static void build_device(struct ast_config *cfg, const char *name)
1325 {
1326         struct ast_variable *v;
1327         struct console_pvt *pvt;
1328         int new = 0;
1329
1330         if ((pvt = find_pvt(name))) {
1331                 console_pvt_lock(pvt);
1332                 set_pvt_defaults(pvt);
1333                 pvt->destroy = 0;
1334         } else {
1335                 if (!(pvt = ao2_alloc(sizeof(*pvt), pvt_destructor)))
1336                         return;
1337                 init_pvt(pvt, name);
1338                 set_pvt_defaults(pvt);
1339                 new = 1;
1340         }
1341
1342         for (v = ast_variable_browse(cfg, name); v; v = v->next)
1343                 store_config_core(pvt, v->name, v->value);
1344
1345         if (new)
1346                 ao2_link(pvts, pvt);
1347         else
1348                 console_pvt_unlock(pvt);
1349         
1350         unref_pvt(pvt);
1351 }
1352
1353 static int pvt_mark_destroy_cb(void *obj, void *arg, int flags)
1354 {
1355         struct console_pvt *pvt = obj;
1356         pvt->destroy = 1;
1357         return 0;
1358 }
1359
1360 static void destroy_pvts(void)
1361 {
1362         struct ao2_iterator i;
1363         struct console_pvt *pvt;
1364
1365         i = ao2_iterator_init(pvts, 0);
1366         while ((pvt = ao2_iterator_next(&i))) {
1367                 if (pvt->destroy) {
1368                         ao2_unlink(pvts, pvt);
1369                         ast_rwlock_wrlock(&active_lock);
1370                         if (active_pvt == pvt)
1371                                 active_pvt = unref_pvt(pvt);
1372                         ast_rwlock_unlock(&active_lock);
1373                 }
1374                 unref_pvt(pvt);
1375         }
1376         ao2_iterator_destroy(&i);
1377 }
1378
1379 /*!
1380  * \brief Load the configuration
1381  * \param reload if this was called due to a reload
1382  * \retval 0 success
1383  * \retval -1 failure
1384  */
1385 static int load_config(int reload)
1386 {
1387         struct ast_config *cfg;
1388         struct ast_variable *v;
1389         struct ast_flags config_flags = { 0 };
1390         char *context = NULL;
1391
1392         /* default values */
1393         memcpy(&global_jbconf, &default_jbconf, sizeof(global_jbconf));
1394         ast_mutex_lock(&globals_lock);
1395         set_pvt_defaults(&globals);
1396         ast_mutex_unlock(&globals_lock);
1397
1398         if (!(cfg = ast_config_load(config_file, config_flags))) {
1399                 ast_log(LOG_NOTICE, "Unable to open configuration file %s!\n", config_file);
1400                 return -1;
1401         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
1402                 ast_log(LOG_NOTICE, "Config file %s has an invalid format\n", config_file);
1403                 return -1;
1404         }
1405         
1406         ao2_callback(pvts, OBJ_NODATA, pvt_mark_destroy_cb, NULL);
1407
1408         ast_mutex_lock(&globals_lock);
1409         for (v = ast_variable_browse(cfg, "general"); v; v = v->next)
1410                 store_config_core(&globals, v->name, v->value);
1411         ast_mutex_unlock(&globals_lock);
1412
1413         while ((context = ast_category_browse(cfg, context))) {
1414                 if (strcasecmp(context, "general"))
1415                         build_device(cfg, context);
1416         }
1417
1418         ast_config_destroy(cfg);
1419
1420         destroy_pvts();
1421
1422         return 0;
1423 }
1424
1425 static int pvt_hash_cb(const void *obj, const int flags)
1426 {
1427         const struct console_pvt *pvt = obj;
1428
1429         return ast_str_case_hash(pvt->name);
1430 }
1431
1432 static int pvt_cmp_cb(void *obj, void *arg, int flags)
1433 {
1434         struct console_pvt *pvt = obj, *pvt2 = arg;
1435
1436         return !strcasecmp(pvt->name, pvt2->name) ? CMP_MATCH | CMP_STOP : 0;
1437 }
1438
1439 static void stop_streams(void)
1440 {
1441         struct console_pvt *pvt;
1442         struct ao2_iterator i;
1443
1444         i = ao2_iterator_init(pvts, 0);
1445         while ((pvt = ao2_iterator_next(&i))) {
1446                 if (pvt->hookstate)
1447                         stop_stream(pvt);
1448                 unref_pvt(pvt);
1449         }
1450         ao2_iterator_destroy(&i);
1451 }
1452
1453 static int unload_module(void)
1454 {
1455         console_tech.capabilities = ast_format_cap_destroy(console_tech.capabilities);
1456         ast_channel_unregister(&console_tech);
1457         ast_cli_unregister_multiple(cli_console, ARRAY_LEN(cli_console));
1458
1459         stop_streams();
1460
1461         Pa_Terminate();
1462
1463         /* Will unref all the pvts so they will get destroyed, too */
1464         ao2_ref(pvts, -1);
1465
1466         pvt_destructor(&globals);
1467
1468         return 0;
1469 }
1470
1471 static int load_module(void)
1472 {
1473         struct ast_format tmpfmt;
1474         PaError res;
1475
1476         if (!(console_tech.capabilities = ast_format_cap_alloc())) {
1477                 return AST_MODULE_LOAD_DECLINE;
1478         }
1479         ast_format_cap_add(console_tech.capabilities, ast_format_set(&tmpfmt, AST_FORMAT_SLINEAR16, 0));
1480
1481         init_pvt(&globals, NULL);
1482
1483         if (!(pvts = ao2_container_alloc(NUM_PVT_BUCKETS, pvt_hash_cb, pvt_cmp_cb)))
1484                 goto return_error;
1485
1486         if (load_config(0))
1487                 goto return_error;
1488
1489         res = Pa_Initialize();
1490         if (res != paNoError) {
1491                 ast_log(LOG_WARNING, "Failed to initialize audio system - (%d) %s\n",
1492                         res, Pa_GetErrorText(res));
1493                 goto return_error_pa_init;
1494         }
1495
1496         if (ast_channel_register(&console_tech)) {
1497                 ast_log(LOG_ERROR, "Unable to register channel type 'Console'\n");
1498                 goto return_error_chan_reg;
1499         }
1500
1501         if (ast_cli_register_multiple(cli_console, ARRAY_LEN(cli_console)))
1502                 goto return_error_cli_reg;
1503
1504         return AST_MODULE_LOAD_SUCCESS;
1505
1506 return_error_cli_reg:
1507         ast_cli_unregister_multiple(cli_console, ARRAY_LEN(cli_console));
1508 return_error_chan_reg:
1509         ast_channel_unregister(&console_tech);
1510 return_error_pa_init:
1511         Pa_Terminate();
1512 return_error:
1513         if (pvts)
1514                 ao2_ref(pvts, -1);
1515         pvts = NULL;
1516         pvt_destructor(&globals);
1517
1518         return AST_MODULE_LOAD_DECLINE;
1519 }
1520
1521 static int reload(void)
1522 {
1523         return load_config(1);
1524 }
1525
1526 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Console Channel Driver",
1527                 .load = load_module,
1528                 .unload = unload_module,
1529                 .reload = reload,
1530                 .load_pri = AST_MODPRI_CHANNEL_DRIVER,
1531 );