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