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