aco: Create ways to minimize use of regex.
[asterisk/asterisk.git] / channels / chan_oss.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2007, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * FreeBSD changes and multiple device support by Luigi Rizzo, 2005.05.25
9  * note-this code best seen with ts=8 (8-spaces tabs) in the editor
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  * This program is free software, distributed under the terms of
18  * the GNU General Public License Version 2. See the LICENSE file
19  * at the top of the source tree.
20  */
21
22 // #define HAVE_VIDEO_CONSOLE   // uncomment to enable video
23 /*! \file
24  *
25  * \brief Channel driver for OSS sound cards
26  *
27  * \author Mark Spencer <markster@digium.com>
28  * \author Luigi Rizzo
29  *
30  * \ingroup channel_drivers
31  */
32
33 /*! \li \ref chan_oss.c uses the configuration file \ref oss.conf
34  * \addtogroup configuration_file
35  */
36
37 /*! \page oss.conf oss.conf
38  * \verbinclude oss.conf.sample
39  */
40
41 /*** MODULEINFO
42         <depend>oss</depend>
43         <support_level>extended</support_level>
44  ***/
45
46 #include "asterisk.h"
47
48 #include <ctype.h>              /* isalnum() used here */
49 #include <math.h>
50 #include <sys/ioctl.h>          
51
52 #ifdef __linux
53 #include <linux/soundcard.h>
54 #elif defined(__FreeBSD__) || defined(__CYGWIN__) || defined(__GLIBC__) || defined(__sun)
55 #include <sys/soundcard.h>
56 #else
57 #include <soundcard.h>
58 #endif
59
60 #include "asterisk/channel.h"
61 #include "asterisk/file.h"
62 #include "asterisk/callerid.h"
63 #include "asterisk/module.h"
64 #include "asterisk/pbx.h"
65 #include "asterisk/cli.h"
66 #include "asterisk/causes.h"
67 #include "asterisk/musiconhold.h"
68 #include "asterisk/app.h"
69 #include "asterisk/bridge.h"
70 #include "asterisk/format_cache.h"
71
72 #include "console_video.h"
73
74 /*! Global jitterbuffer configuration - by default, jb is disabled
75  *  \note Values shown here match the defaults shown in oss.conf.sample */
76 static struct ast_jb_conf default_jbconf =
77 {
78         .flags = 0,
79         .max_size = 200,
80         .resync_threshold = 1000,
81         .impl = "fixed",
82         .target_extra = 40,
83 };
84 static struct ast_jb_conf global_jbconf;
85
86 /*
87  * Basic mode of operation:
88  *
89  * we have one keyboard (which receives commands from the keyboard)
90  * and multiple headset's connected to audio cards.
91  * Cards/Headsets are named as the sections of oss.conf.
92  * The section called [general] contains the default parameters.
93  *
94  * At any time, the keyboard is attached to one card, and you
95  * can switch among them using the command 'console foo'
96  * where 'foo' is the name of the card you want.
97  *
98  * oss.conf parameters are
99 START_CONFIG
100
101 [general]
102     ; General config options, with default values shown.
103     ; You should use one section per device, with [general] being used
104     ; for the first device and also as a template for other devices.
105     ;
106     ; All but 'debug' can go also in the device-specific sections.
107     ;
108     ; debug = 0x0               ; misc debug flags, default is 0
109
110     ; Set the device to use for I/O
111     ; device = /dev/dsp
112
113     ; Optional mixer command to run upon startup (e.g. to set
114     ; volume levels, mutes, etc.
115     ; mixer =
116
117     ; Software mic volume booster (or attenuator), useful for sound
118     ; cards or microphones with poor sensitivity. The volume level
119     ; is in dB, ranging from -20.0 to +20.0
120     ; boost = n                 ; mic volume boost in dB
121
122     ; Set the callerid for outgoing calls
123     ; callerid = John Doe <555-1234>
124
125     ; autoanswer = no           ; no autoanswer on call
126     ; autohangup = yes          ; hangup when other party closes
127     ; extension = s             ; default extension to call
128     ; context = default         ; default context for outgoing calls
129     ; language = ""             ; default language
130
131     ; Default Music on Hold class to use when this channel is placed on hold in
132     ; the case that the music class is not set on the channel with
133     ; Set(CHANNEL(musicclass)=whatever) in the dialplan and the peer channel
134     ; putting this one on hold did not suggest a class to use.
135     ;
136     ; mohinterpret=default
137
138     ; If you set overridecontext to 'yes', then the whole dial string
139     ; will be interpreted as an extension, which is extremely useful
140     ; to dial SIP, IAX and other extensions which use the '@' character.
141     ; The default is 'no' just for backward compatibility, but the
142     ; suggestion is to change it.
143     ; overridecontext = no      ; if 'no', the last @ will start the context
144                                 ; if 'yes' the whole string is an extension.
145
146     ; low level device parameters in case you have problems with the
147     ; device driver on your operating system. You should not touch these
148     ; unless you know what you are doing.
149     ; queuesize = 10            ; frames in device driver
150     ; frags = 8                 ; argument to SETFRAGMENT
151
152     ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
153     ; jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of an
154                                   ; OSS channel. Defaults to "no". An enabled jitterbuffer will
155                                   ; be used only if the sending side can create and the receiving
156                                   ; side can not accept jitter. The OSS channel can't accept jitter,
157                                   ; thus an enabled jitterbuffer on the receive OSS side will always
158                                   ; be used if the sending side can create jitter.
159
160     ; jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
161
162     ; jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
163                                   ; resynchronized. Useful to improve the quality of the voice, with
164                                   ; big jumps in/broken timestamps, usualy sent from exotic devices
165                                   ; and programs. Defaults to 1000.
166
167     ; jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of an OSS
168                                   ; channel. Two implementations are currenlty available - "fixed"
169                                   ; (with size always equals to jbmax-size) and "adaptive" (with
170                                   ; variable size, actually the new jb of IAX2). Defaults to fixed.
171
172     ; jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
173     ;-----------------------------------------------------------------------------------
174
175 [card1]
176     ; device = /dev/dsp1        ; alternate device
177
178 END_CONFIG
179
180 .. and so on for the other cards.
181
182  */
183
184 /*
185  * The following parameters are used in the driver:
186  *
187  *  FRAME_SIZE  the size of an audio frame, in samples.
188  *              160 is used almost universally, so you should not change it.
189  *
190  *  FRAGS       the argument for the SETFRAGMENT ioctl.
191  *              Overridden by the 'frags' parameter in oss.conf
192  *
193  *              Bits 0-7 are the base-2 log of the device's block size,
194  *              bits 16-31 are the number of blocks in the driver's queue.
195  *              There are a lot of differences in the way this parameter
196  *              is supported by different drivers, so you may need to
197  *              experiment a bit with the value.
198  *              A good default for linux is 30 blocks of 64 bytes, which
199  *              results in 6 frames of 320 bytes (160 samples).
200  *              FreeBSD works decently with blocks of 256 or 512 bytes,
201  *              leaving the number unspecified.
202  *              Note that this only refers to the device buffer size,
203  *              this module will then try to keep the lenght of audio
204  *              buffered within small constraints.
205  *
206  *  QUEUE_SIZE  The max number of blocks actually allowed in the device
207  *              driver's buffer, irrespective of the available number.
208  *              Overridden by the 'queuesize' parameter in oss.conf
209  *
210  *              Should be >=2, and at most as large as the hw queue above
211  *              (otherwise it will never be full).
212  */
213
214 #define FRAME_SIZE      160
215 #define QUEUE_SIZE      10
216
217 #if defined(__FreeBSD__)
218 #define FRAGS   0x8
219 #else
220 #define FRAGS   ( ( (6 * 5) << 16 ) | 0x6 )
221 #endif
222
223 /*
224  * XXX text message sizes are probably 256 chars, but i am
225  * not sure if there is a suitable definition anywhere.
226  */
227 #define TEXT_SIZE       256
228
229 #if 0
230 #define TRYOPEN 1                               /* try to open on startup */
231 #endif
232 #define O_CLOSE 0x444                   /* special 'close' mode for device */
233 /* Which device to use */
234 #if defined( __OpenBSD__ ) || defined( __NetBSD__ )
235 #define DEV_DSP "/dev/audio"
236 #else
237 #define DEV_DSP "/dev/dsp"
238 #endif
239
240 static char *config = "oss.conf";       /* default config file */
241
242 static int oss_debug;
243
244 /*!
245  * \brief descriptor for one of our channels.
246  *
247  * There is one used for 'default' values (from the [general] entry in
248  * the configuration file), and then one instance for each device
249  * (the default is cloned from [general], others are only created
250  * if the relevant section exists).
251  */
252 struct chan_oss_pvt {
253         struct chan_oss_pvt *next;
254
255         char *name;
256         int total_blocks;                       /*!< total blocks in the output device */
257         int sounddev;
258         enum { M_UNSET, M_FULL, M_READ, M_WRITE } duplex;
259         int autoanswer;             /*!< Boolean: whether to answer the immediately upon calling */
260         int autohangup;             /*!< Boolean: whether to hangup the call when the remote end hangs up */
261         int hookstate;              /*!< Boolean: 1 if offhook; 0 if onhook */
262         char *mixer_cmd;                        /*!< initial command to issue to the mixer */
263         unsigned int queuesize;         /*!< max fragments in queue */
264         unsigned int frags;                     /*!< parameter for SETFRAGMENT */
265
266         int warned;                                     /*!< various flags used for warnings */
267 #define WARN_used_blocks        1
268 #define WARN_speed              2
269 #define WARN_frag               4
270         int w_errors;                           /*!< overfull in the write path */
271         struct timeval lastopen;
272
273         int overridecontext;
274         int mute;
275
276         /*! boost support. BOOST_SCALE * 10 ^(BOOST_MAX/20) must
277          *  be representable in 16 bits to avoid overflows.
278          */
279 #define BOOST_SCALE     (1<<9)
280 #define BOOST_MAX       40                      /*!< slightly less than 7 bits */
281         int boost;                                      /*!< input boost, scaled by BOOST_SCALE */
282         char device[64];                        /*!< device to open */
283
284         pthread_t sthread;
285
286         struct ast_channel *owner;
287
288         struct video_desc *env;                 /*!< parameters for video support */
289
290         char ext[AST_MAX_EXTENSION];
291         char ctx[AST_MAX_CONTEXT];
292         char language[MAX_LANGUAGE];
293         char cid_name[256];         /*!< Initial CallerID name */
294         char cid_num[256];          /*!< Initial CallerID number  */
295         char mohinterpret[MAX_MUSICCLASS];
296
297         /*! buffers used in oss_write */
298         char oss_write_buf[FRAME_SIZE * 2];
299         int oss_write_dst;
300         /*! buffers used in oss_read - AST_FRIENDLY_OFFSET space for headers
301          *  plus enough room for a full frame
302          */
303         char oss_read_buf[FRAME_SIZE * 2 + AST_FRIENDLY_OFFSET];
304         int readpos;                            /*!< read position above */
305         struct ast_frame read_f;        /*!< returned by oss_read */
306 };
307
308 /*! forward declaration */
309 static struct chan_oss_pvt *find_desc(const char *dev);
310
311 static char *oss_active;         /*!< the active device */
312
313 /*! \brief return the pointer to the video descriptor */
314 struct video_desc *get_video_desc(struct ast_channel *c)
315 {
316         struct chan_oss_pvt *o = c ? ast_channel_tech_pvt(c) : find_desc(oss_active);
317         return o ? o->env : NULL;
318 }
319 static struct chan_oss_pvt oss_default = {
320         .sounddev = -1,
321         .duplex = M_UNSET,                      /* XXX check this */
322         .autoanswer = 1,
323         .autohangup = 1,
324         .queuesize = QUEUE_SIZE,
325         .frags = FRAGS,
326         .ext = "s",
327         .ctx = "default",
328         .readpos = AST_FRIENDLY_OFFSET, /* start here on reads */
329         .lastopen = { 0, 0 },
330         .boost = BOOST_SCALE,
331 };
332
333
334 static int setformat(struct chan_oss_pvt *o, int mode);
335
336 static struct ast_channel *oss_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor,
337                                                                            const char *data, int *cause);
338 static int oss_digit_begin(struct ast_channel *c, char digit);
339 static int oss_digit_end(struct ast_channel *c, char digit, unsigned int duration);
340 static int oss_text(struct ast_channel *c, const char *text);
341 static int oss_hangup(struct ast_channel *c);
342 static int oss_answer(struct ast_channel *c);
343 static struct ast_frame *oss_read(struct ast_channel *chan);
344 static int oss_call(struct ast_channel *c, const char *dest, int timeout);
345 static int oss_write(struct ast_channel *chan, struct ast_frame *f);
346 static int oss_indicate(struct ast_channel *chan, int cond, const void *data, size_t datalen);
347 static int oss_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
348 static char tdesc[] = "OSS Console Channel Driver";
349
350 /* cannot do const because need to update some fields at runtime */
351 static struct ast_channel_tech oss_tech = {
352         .type = "Console",
353         .description = tdesc,
354         .requester = oss_request,
355         .send_digit_begin = oss_digit_begin,
356         .send_digit_end = oss_digit_end,
357         .send_text = oss_text,
358         .hangup = oss_hangup,
359         .answer = oss_answer,
360         .read = oss_read,
361         .call = oss_call,
362         .write = oss_write,
363         .write_video = console_write_video,
364         .indicate = oss_indicate,
365         .fixup = oss_fixup,
366 };
367
368 /*!
369  * \brief returns a pointer to the descriptor with the given name
370  */
371 static struct chan_oss_pvt *find_desc(const char *dev)
372 {
373         struct chan_oss_pvt *o = NULL;
374
375         if (!dev)
376                 ast_log(LOG_WARNING, "null dev\n");
377
378         for (o = oss_default.next; o && o->name && dev && strcmp(o->name, dev) != 0; o = o->next);
379
380         if (!o)
381                 ast_log(LOG_WARNING, "could not find <%s>\n", dev ? dev : "--no-device--");
382
383         return o;
384 }
385
386 /* !
387  * \brief split a string in extension-context, returns pointers to malloc'ed
388  *        strings.
389  *
390  * If we do not have 'overridecontext' then the last @ is considered as
391  * a context separator, and the context is overridden.
392  * This is usually not very necessary as you can play with the dialplan,
393  * and it is nice not to need it because you have '@' in SIP addresses.
394  *
395  * \return the buffer address.
396  */
397 static char *ast_ext_ctx(const char *src, char **ext, char **ctx)
398 {
399         struct chan_oss_pvt *o = find_desc(oss_active);
400
401         if (ext == NULL || ctx == NULL)
402                 return NULL;                    /* error */
403
404         *ext = *ctx = NULL;
405
406         if (src && *src != '\0')
407                 *ext = ast_strdup(src);
408
409         if (*ext == NULL)
410                 return NULL;
411
412         if (!o->overridecontext) {
413                 /* parse from the right */
414                 *ctx = strrchr(*ext, '@');
415                 if (*ctx)
416                         *(*ctx)++ = '\0';
417         }
418
419         return *ext;
420 }
421
422 /*!
423  * \brief Returns the number of blocks used in the audio output channel
424  */
425 static int used_blocks(struct chan_oss_pvt *o)
426 {
427         struct audio_buf_info info;
428
429         if (ioctl(o->sounddev, SNDCTL_DSP_GETOSPACE, &info)) {
430                 if (!(o->warned & WARN_used_blocks)) {
431                         ast_log(LOG_WARNING, "Error reading output space\n");
432                         o->warned |= WARN_used_blocks;
433                 }
434                 return 1;
435         }
436
437         if (o->total_blocks == 0) {
438                 if (0)                                  /* debugging */
439                         ast_log(LOG_WARNING, "fragtotal %d size %d avail %d\n", info.fragstotal, info.fragsize, info.fragments);
440                 o->total_blocks = info.fragments;
441         }
442
443         return o->total_blocks - info.fragments;
444 }
445
446 /*! Write an exactly FRAME_SIZE sized frame */
447 static int soundcard_writeframe(struct chan_oss_pvt *o, short *data)
448 {
449         int res;
450
451         if (o->sounddev < 0)
452                 setformat(o, O_RDWR);
453         if (o->sounddev < 0)
454                 return 0;                               /* not fatal */
455         /*
456          * Nothing complex to manage the audio device queue.
457          * If the buffer is full just drop the extra, otherwise write.
458          * XXX in some cases it might be useful to write anyways after
459          * a number of failures, to restart the output chain.
460          */
461         res = used_blocks(o);
462         if (res > o->queuesize) {       /* no room to write a block */
463                 if (o->w_errors++ == 0 && (oss_debug & 0x4))
464                         ast_log(LOG_WARNING, "write: used %d blocks (%d)\n", res, o->w_errors);
465                 return 0;
466         }
467         o->w_errors = 0;
468         return write(o->sounddev, (void *)data, FRAME_SIZE * 2);
469 }
470
471 /*!
472  * reset and close the device if opened,
473  * then open and initialize it in the desired mode,
474  * trigger reads and writes so we can start using it.
475  */
476 static int setformat(struct chan_oss_pvt *o, int mode)
477 {
478         int fmt, desired, res, fd;
479
480         if (o->sounddev >= 0) {
481                 ioctl(o->sounddev, SNDCTL_DSP_RESET, 0);
482                 close(o->sounddev);
483                 o->duplex = M_UNSET;
484                 o->sounddev = -1;
485         }
486         if (mode == O_CLOSE)            /* we are done */
487                 return 0;
488         if (ast_tvdiff_ms(ast_tvnow(), o->lastopen) < 1000)
489                 return -1;                              /* don't open too often */
490         o->lastopen = ast_tvnow();
491         fd = o->sounddev = open(o->device, mode | O_NONBLOCK);
492         if (fd < 0) {
493                 ast_log(LOG_WARNING, "Unable to re-open DSP device %s: %s\n", o->device, strerror(errno));
494                 return -1;
495         }
496         if (o->owner)
497                 ast_channel_set_fd(o->owner, 0, fd);
498
499 #if __BYTE_ORDER == __LITTLE_ENDIAN
500         fmt = AFMT_S16_LE;
501 #else
502         fmt = AFMT_S16_BE;
503 #endif
504         res = ioctl(fd, SNDCTL_DSP_SETFMT, &fmt);
505         if (res < 0) {
506                 ast_log(LOG_WARNING, "Unable to set format to 16-bit signed\n");
507                 return -1;
508         }
509         switch (mode) {
510         case O_RDWR:
511                 res = ioctl(fd, SNDCTL_DSP_SETDUPLEX, 0);
512                 /* Check to see if duplex set (FreeBSD Bug) */
513                 res = ioctl(fd, SNDCTL_DSP_GETCAPS, &fmt);
514                 if (res == 0 && (fmt & DSP_CAP_DUPLEX)) {
515                         ast_verb(2, "Console is full duplex\n");
516                         o->duplex = M_FULL;
517                 };
518                 break;
519
520         case O_WRONLY:
521                 o->duplex = M_WRITE;
522                 break;
523
524         case O_RDONLY:
525                 o->duplex = M_READ;
526                 break;
527         }
528
529         fmt = 0;
530         res = ioctl(fd, SNDCTL_DSP_STEREO, &fmt);
531         if (res < 0) {
532                 ast_log(LOG_WARNING, "Failed to set audio device to mono\n");
533                 return -1;
534         }
535         fmt = desired = DEFAULT_SAMPLE_RATE;    /* 8000 Hz desired */
536         res = ioctl(fd, SNDCTL_DSP_SPEED, &fmt);
537
538         if (res < 0) {
539                 ast_log(LOG_WARNING, "Failed to set sample rate to %d\n", desired);
540                 return -1;
541         }
542         if (fmt != desired) {
543                 if (!(o->warned & WARN_speed)) {
544                         ast_log(LOG_WARNING,
545                             "Requested %d Hz, got %d Hz -- sound may be choppy\n",
546                             desired, fmt);
547                         o->warned |= WARN_speed;
548                 }
549         }
550         /*
551          * on Freebsd, SETFRAGMENT does not work very well on some cards.
552          * Default to use 256 bytes, let the user override
553          */
554         if (o->frags) {
555                 fmt = o->frags;
556                 res = ioctl(fd, SNDCTL_DSP_SETFRAGMENT, &fmt);
557                 if (res < 0) {
558                         if (!(o->warned & WARN_frag)) {
559                                 ast_log(LOG_WARNING,
560                                         "Unable to set fragment size -- sound may be choppy\n");
561                                 o->warned |= WARN_frag;
562                         }
563                 }
564         }
565         /* on some cards, we need SNDCTL_DSP_SETTRIGGER to start outputting */
566         res = PCM_ENABLE_INPUT | PCM_ENABLE_OUTPUT;
567         res = ioctl(fd, SNDCTL_DSP_SETTRIGGER, &res);
568         /* it may fail if we are in half duplex, never mind */
569         return 0;
570 }
571
572 /*
573  * some of the standard methods supported by channels.
574  */
575 static int oss_digit_begin(struct ast_channel *c, char digit)
576 {
577         return 0;
578 }
579
580 static int oss_digit_end(struct ast_channel *c, char digit, unsigned int duration)
581 {
582         /* no better use for received digits than print them */
583         ast_verbose(" << Console Received digit %c of duration %u ms >> \n", 
584                 digit, duration);
585         return 0;
586 }
587
588 static int oss_text(struct ast_channel *c, const char *text)
589 {
590         /* print received messages */
591         ast_verbose(" << Console Received text %s >> \n", text);
592         return 0;
593 }
594
595 /*!
596  * \brief handler for incoming calls. Either autoanswer, or start ringing
597  */
598 static int oss_call(struct ast_channel *c, const char *dest, int timeout)
599 {
600         struct chan_oss_pvt *o = ast_channel_tech_pvt(c);
601         struct ast_frame f = { AST_FRAME_CONTROL, };
602         AST_DECLARE_APP_ARGS(args,
603                 AST_APP_ARG(name);
604                 AST_APP_ARG(flags);
605         );
606         char *parse = ast_strdupa(dest);
607
608         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
609
610         ast_verbose(" << Call to device '%s' dnid '%s' rdnis '%s' on console from '%s' <%s> >>\n",
611                 dest,
612                 S_OR(ast_channel_dialed(c)->number.str, ""),
613                 S_COR(ast_channel_redirecting(c)->from.number.valid, ast_channel_redirecting(c)->from.number.str, ""),
614                 S_COR(ast_channel_caller(c)->id.name.valid, ast_channel_caller(c)->id.name.str, ""),
615                 S_COR(ast_channel_caller(c)->id.number.valid, ast_channel_caller(c)->id.number.str, ""));
616         if (!ast_strlen_zero(args.flags) && strcasecmp(args.flags, "answer") == 0) {
617                 f.subclass.integer = AST_CONTROL_ANSWER;
618                 ast_queue_frame(c, &f);
619         } else if (!ast_strlen_zero(args.flags) && strcasecmp(args.flags, "noanswer") == 0) {
620                 f.subclass.integer = AST_CONTROL_RINGING;
621                 ast_queue_frame(c, &f);
622                 ast_indicate(c, AST_CONTROL_RINGING);
623         } else if (o->autoanswer) {
624                 ast_verbose(" << Auto-answered >> \n");
625                 f.subclass.integer = AST_CONTROL_ANSWER;
626                 ast_queue_frame(c, &f);
627                 o->hookstate = 1;
628         } else {
629                 ast_verbose("<< Type 'answer' to answer, or use 'autoanswer' for future calls >> \n");
630                 f.subclass.integer = AST_CONTROL_RINGING;
631                 ast_queue_frame(c, &f);
632                 ast_indicate(c, AST_CONTROL_RINGING);
633         }
634         return 0;
635 }
636
637 /*!
638  * \brief remote side answered the phone
639  */
640 static int oss_answer(struct ast_channel *c)
641 {
642         struct chan_oss_pvt *o = ast_channel_tech_pvt(c);
643         ast_verbose(" << Console call has been answered >> \n");
644         ast_setstate(c, AST_STATE_UP);
645         o->hookstate = 1;
646         return 0;
647 }
648
649 static int oss_hangup(struct ast_channel *c)
650 {
651         struct chan_oss_pvt *o = ast_channel_tech_pvt(c);
652
653         ast_channel_tech_pvt_set(c, NULL);
654         o->owner = NULL;
655         ast_verbose(" << Hangup on console >> \n");
656         console_video_uninit(o->env);
657         ast_module_unref(ast_module_info->self);
658         if (o->hookstate) {
659                 if (o->autoanswer || o->autohangup) {
660                         /* Assume auto-hangup too */
661                         o->hookstate = 0;
662                         setformat(o, O_CLOSE);
663                 }
664         }
665         return 0;
666 }
667
668 /*! \brief used for data coming from the network */
669 static int oss_write(struct ast_channel *c, struct ast_frame *f)
670 {
671         int src;
672         struct chan_oss_pvt *o = ast_channel_tech_pvt(c);
673
674         /*
675          * we could receive a block which is not a multiple of our
676          * FRAME_SIZE, so buffer it locally and write to the device
677          * in FRAME_SIZE chunks.
678          * Keep the residue stored for future use.
679          */
680         src = 0;                                        /* read position into f->data */
681         while (src < f->datalen) {
682                 /* Compute spare room in the buffer */
683                 int l = sizeof(o->oss_write_buf) - o->oss_write_dst;
684
685                 if (f->datalen - src >= l) {    /* enough to fill a frame */
686                         memcpy(o->oss_write_buf + o->oss_write_dst, f->data.ptr + src, l);
687                         soundcard_writeframe(o, (short *) o->oss_write_buf);
688                         src += l;
689                         o->oss_write_dst = 0;
690                 } else {                                /* copy residue */
691                         l = f->datalen - src;
692                         memcpy(o->oss_write_buf + o->oss_write_dst, f->data.ptr + src, l);
693                         src += l;                       /* but really, we are done */
694                         o->oss_write_dst += l;
695                 }
696         }
697         return 0;
698 }
699
700 static struct ast_frame *oss_read(struct ast_channel *c)
701 {
702         int res;
703         struct chan_oss_pvt *o = ast_channel_tech_pvt(c);
704         struct ast_frame *f = &o->read_f;
705
706         /* XXX can be simplified returning &ast_null_frame */
707         /* prepare a NULL frame in case we don't have enough data to return */
708         memset(f, '\0', sizeof(struct ast_frame));
709         f->frametype = AST_FRAME_NULL;
710         f->src = oss_tech.type;
711
712         res = read(o->sounddev, o->oss_read_buf + o->readpos, sizeof(o->oss_read_buf) - o->readpos);
713         if (res < 0)                            /* audio data not ready, return a NULL frame */
714                 return f;
715
716         o->readpos += res;
717         if (o->readpos < sizeof(o->oss_read_buf))       /* not enough samples */
718                 return f;
719
720         if (o->mute)
721                 return f;
722
723         o->readpos = AST_FRIENDLY_OFFSET;       /* reset read pointer for next frame */
724         if (ast_channel_state(c) != AST_STATE_UP)       /* drop data if frame is not up */
725                 return f;
726         /* ok we can build and deliver the frame to the caller */
727         f->frametype = AST_FRAME_VOICE;
728         f->subclass.format = ast_format_slin;
729         f->samples = FRAME_SIZE;
730         f->datalen = FRAME_SIZE * 2;
731         f->data.ptr = o->oss_read_buf + AST_FRIENDLY_OFFSET;
732         if (o->boost != BOOST_SCALE) {  /* scale and clip values */
733                 int i, x;
734                 int16_t *p = (int16_t *) f->data.ptr;
735                 for (i = 0; i < f->samples; i++) {
736                         x = (p[i] * o->boost) / BOOST_SCALE;
737                         if (x > 32767)
738                                 x = 32767;
739                         else if (x < -32768)
740                                 x = -32768;
741                         p[i] = x;
742                 }
743         }
744
745         f->offset = AST_FRIENDLY_OFFSET;
746         return f;
747 }
748
749 static int oss_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
750 {
751         struct chan_oss_pvt *o = ast_channel_tech_pvt(newchan);
752         o->owner = newchan;
753         return 0;
754 }
755
756 static int oss_indicate(struct ast_channel *c, int cond, const void *data, size_t datalen)
757 {
758         struct chan_oss_pvt *o = ast_channel_tech_pvt(c);
759         int res = 0;
760
761         switch (cond) {
762         case AST_CONTROL_INCOMPLETE:
763         case AST_CONTROL_BUSY:
764         case AST_CONTROL_CONGESTION:
765         case AST_CONTROL_RINGING:
766         case AST_CONTROL_PVT_CAUSE_CODE:
767         case -1:
768                 res = -1;
769                 break;
770         case AST_CONTROL_PROGRESS:
771         case AST_CONTROL_PROCEEDING:
772         case AST_CONTROL_VIDUPDATE:
773         case AST_CONTROL_SRCUPDATE:
774                 break;
775         case AST_CONTROL_HOLD:
776                 ast_verbose(" << Console Has Been Placed on Hold >> \n");
777                 ast_moh_start(c, data, o->mohinterpret);
778                 break;
779         case AST_CONTROL_UNHOLD:
780                 ast_verbose(" << Console Has Been Retrieved from Hold >> \n");
781                 ast_moh_stop(c);
782                 break;
783         default:
784                 ast_log(LOG_WARNING, "Don't know how to display condition %d on %s\n", cond, ast_channel_name(c));
785                 return -1;
786         }
787
788         return res;
789 }
790
791 /*!
792  * \brief allocate a new channel.
793  */
794 static struct ast_channel *oss_new(struct chan_oss_pvt *o, char *ext, char *ctx, int state, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor)
795 {
796         struct ast_channel *c;
797
798         c = ast_channel_alloc(1, state, o->cid_num, o->cid_name, "", ext, ctx, assignedids, requestor, 0, "Console/%s", o->device + 5);
799         if (c == NULL)
800                 return NULL;
801         ast_channel_tech_set(c, &oss_tech);
802         if (o->sounddev < 0)
803                 setformat(o, O_RDWR);
804         ast_channel_set_fd(c, 0, o->sounddev); /* -1 if device closed, override later */
805
806         ast_channel_set_readformat(c, ast_format_slin);
807         ast_channel_set_writeformat(c, ast_format_slin);
808         ast_channel_nativeformats_set(c, oss_tech.capabilities);
809
810         /* if the console makes the call, add video to the offer */
811         /* if (state == AST_STATE_RINGING) TODO XXX CONSOLE VIDEO IS DISABLED UNTIL IT GETS A MAINTAINER
812                 c->nativeformats |= console_video_formats; */
813
814         ast_channel_tech_pvt_set(c, o);
815
816         if (!ast_strlen_zero(o->language))
817                 ast_channel_language_set(c, o->language);
818         /* Don't use ast_set_callerid() here because it will
819          * generate a needless NewCallerID event */
820         if (!ast_strlen_zero(o->cid_num)) {
821                 ast_channel_caller(c)->ani.number.valid = 1;
822                 ast_channel_caller(c)->ani.number.str = ast_strdup(o->cid_num);
823         }
824         if (!ast_strlen_zero(ext)) {
825                 ast_channel_dialed(c)->number.str = ast_strdup(ext);
826         }
827
828         o->owner = c;
829         ast_module_ref(ast_module_info->self);
830         ast_jb_configure(c, &global_jbconf);
831         ast_channel_unlock(c);
832         if (state != AST_STATE_DOWN) {
833                 if (ast_pbx_start(c)) {
834                         ast_log(LOG_WARNING, "Unable to start PBX on %s\n", ast_channel_name(c));
835                         ast_hangup(c);
836                         o->owner = c = NULL;
837                 }
838         }
839         console_video_start(get_video_desc(c), c); /* XXX cleanup */
840
841         return c;
842 }
843
844 static struct ast_channel *oss_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)
845 {
846         struct ast_channel *c;
847         struct chan_oss_pvt *o;
848         AST_DECLARE_APP_ARGS(args,
849                 AST_APP_ARG(name);
850                 AST_APP_ARG(flags);
851         );
852         char *parse = ast_strdupa(data);
853
854         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
855         o = find_desc(args.name);
856
857         ast_log(LOG_WARNING, "oss_request ty <%s> data 0x%p <%s>\n", type, data, data);
858         if (o == NULL) {
859                 ast_log(LOG_NOTICE, "Device %s not found\n", args.name);
860                 /* XXX we could default to 'dsp' perhaps ? */
861                 return NULL;
862         }
863         if (ast_format_cap_iscompatible_format(cap, ast_format_slin) == AST_FORMAT_CMP_NOT_EQUAL) {
864                 struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
865                 ast_log(LOG_NOTICE, "Format %s unsupported\n", ast_format_cap_get_names(cap, &codec_buf));
866                 return NULL;
867         }
868         if (o->owner) {
869                 ast_log(LOG_NOTICE, "Already have a call (chan %p) on the OSS channel\n", o->owner);
870                 *cause = AST_CAUSE_BUSY;
871                 return NULL;
872         }
873         c = oss_new(o, NULL, NULL, AST_STATE_DOWN, assignedids, requestor);
874         if (c == NULL) {
875                 ast_log(LOG_WARNING, "Unable to create new OSS channel\n");
876                 return NULL;
877         }
878         return c;
879 }
880
881 static void store_config_core(struct chan_oss_pvt *o, const char *var, const char *value);
882
883 /*! Generic console command handler. Basically a wrapper for a subset
884  *  of config file options which are also available from the CLI
885  */
886 static char *console_cmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
887 {
888         struct chan_oss_pvt *o = find_desc(oss_active);
889         const char *var, *value;
890         switch (cmd) {
891         case CLI_INIT:
892                 e->command = CONSOLE_VIDEO_CMDS;
893                 e->usage = 
894                         "Usage: " CONSOLE_VIDEO_CMDS "...\n"
895                         "       Generic handler for console commands.\n";
896                 return NULL;
897
898         case CLI_GENERATE:
899                 return NULL;
900         }
901
902         if (a->argc < e->args)
903                 return CLI_SHOWUSAGE;
904         if (o == NULL) {
905                 ast_log(LOG_WARNING, "Cannot find device %s (should not happen!)\n",
906                         oss_active);
907                 return CLI_FAILURE;
908         }
909         var = a->argv[e->args-1];
910         value = a->argc > e->args ? a->argv[e->args] : NULL;
911         if (value)      /* handle setting */
912                 store_config_core(o, var, value);
913         if (!console_video_cli(o->env, var, a->fd))     /* print video-related values */
914                 return CLI_SUCCESS;
915         /* handle other values */
916         if (!strcasecmp(var, "device")) {
917                 ast_cli(a->fd, "device is [%s]\n", o->device);
918         }
919         return CLI_SUCCESS;
920 }
921
922 static char *console_autoanswer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
923 {
924         struct chan_oss_pvt *o = find_desc(oss_active);
925
926         switch (cmd) {
927         case CLI_INIT:
928                 e->command = "console {set|show} autoanswer [on|off]";
929                 e->usage =
930                         "Usage: console {set|show} autoanswer [on|off]\n"
931                         "       Enables or disables autoanswer feature.  If used without\n"
932                         "       argument, displays the current on/off status of autoanswer.\n"
933                         "       The default value of autoanswer is in 'oss.conf'.\n";
934                 return NULL;
935
936         case CLI_GENERATE:
937                 return NULL;
938         }
939
940         if (a->argc == e->args - 1) {
941                 ast_cli(a->fd, "Auto answer is %s.\n", o->autoanswer ? "on" : "off");
942                 return CLI_SUCCESS;
943         }
944         if (a->argc != e->args)
945                 return CLI_SHOWUSAGE;
946         if (o == NULL) {
947                 ast_log(LOG_WARNING, "Cannot find device %s (should not happen!)\n",
948                     oss_active);
949                 return CLI_FAILURE;
950         }
951         if (!strcasecmp(a->argv[e->args-1], "on"))
952                 o->autoanswer = 1;
953         else if (!strcasecmp(a->argv[e->args - 1], "off"))
954                 o->autoanswer = 0;
955         else
956                 return CLI_SHOWUSAGE;
957         return CLI_SUCCESS;
958 }
959
960 /*! \brief helper function for the answer key/cli command */
961 static char *console_do_answer(int fd)
962 {
963         struct ast_frame f = { AST_FRAME_CONTROL, { AST_CONTROL_ANSWER } };
964         struct chan_oss_pvt *o = find_desc(oss_active);
965         if (!o->owner) {
966                 if (fd > -1)
967                         ast_cli(fd, "No one is calling us\n");
968                 return CLI_FAILURE;
969         }
970         o->hookstate = 1;
971         ast_queue_frame(o->owner, &f);
972         return CLI_SUCCESS;
973 }
974
975 /*!
976  * \brief answer command from the console
977  */
978 static char *console_answer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
979 {
980         switch (cmd) {
981         case CLI_INIT:
982                 e->command = "console answer";
983                 e->usage =
984                         "Usage: console answer\n"
985                         "       Answers an incoming call on the console (OSS) channel.\n";
986                 return NULL;
987
988         case CLI_GENERATE:
989                 return NULL;    /* no completion */
990         }
991         if (a->argc != e->args)
992                 return CLI_SHOWUSAGE;
993         return console_do_answer(a->fd);
994 }
995
996 /*!
997  * \brief Console send text CLI command
998  *
999  * \note concatenate all arguments into a single string. argv is NULL-terminated
1000  * so we can use it right away
1001  */
1002 static char *console_sendtext(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1003 {
1004         struct chan_oss_pvt *o = find_desc(oss_active);
1005         char buf[TEXT_SIZE];
1006
1007         if (cmd == CLI_INIT) {
1008                 e->command = "console send text";
1009                 e->usage =
1010                         "Usage: console send text <message>\n"
1011                         "       Sends a text message for display on the remote terminal.\n";
1012                 return NULL;
1013         } else if (cmd == CLI_GENERATE)
1014                 return NULL;
1015
1016         if (a->argc < e->args + 1)
1017                 return CLI_SHOWUSAGE;
1018         if (!o->owner) {
1019                 ast_cli(a->fd, "Not in a call\n");
1020                 return CLI_FAILURE;
1021         }
1022         ast_join(buf, sizeof(buf) - 1, a->argv + e->args);
1023         if (!ast_strlen_zero(buf)) {
1024                 struct ast_frame f = { 0, };
1025                 int i = strlen(buf);
1026                 buf[i] = '\n';
1027                 f.frametype = AST_FRAME_TEXT;
1028                 f.subclass.integer = 0;
1029                 f.data.ptr = buf;
1030                 f.datalen = i + 1;
1031                 ast_queue_frame(o->owner, &f);
1032         }
1033         return CLI_SUCCESS;
1034 }
1035
1036 static char *console_hangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1037 {
1038         struct chan_oss_pvt *o = find_desc(oss_active);
1039
1040         if (cmd == CLI_INIT) {
1041                 e->command = "console hangup";
1042                 e->usage =
1043                         "Usage: console hangup\n"
1044                         "       Hangs up any call currently placed on the console.\n";
1045                 return NULL;
1046         } else if (cmd == CLI_GENERATE)
1047                 return NULL;
1048
1049         if (a->argc != e->args)
1050                 return CLI_SHOWUSAGE;
1051         if (!o->owner && !o->hookstate) { /* XXX maybe only one ? */
1052                 ast_cli(a->fd, "No call to hang up\n");
1053                 return CLI_FAILURE;
1054         }
1055         o->hookstate = 0;
1056         if (o->owner)
1057                 ast_queue_hangup_with_cause(o->owner, AST_CAUSE_NORMAL_CLEARING);
1058         setformat(o, O_CLOSE);
1059         return CLI_SUCCESS;
1060 }
1061
1062 static char *console_flash(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1063 {
1064         struct ast_frame f = { AST_FRAME_CONTROL, { AST_CONTROL_FLASH } };
1065         struct chan_oss_pvt *o = find_desc(oss_active);
1066
1067         if (cmd == CLI_INIT) {
1068                 e->command = "console flash";
1069                 e->usage =
1070                         "Usage: console flash\n"
1071                         "       Flashes the call currently placed on the console.\n";
1072                 return NULL;
1073         } else if (cmd == CLI_GENERATE)
1074                 return NULL;
1075
1076         if (a->argc != e->args)
1077                 return CLI_SHOWUSAGE;
1078         if (!o->owner) {                        /* XXX maybe !o->hookstate too ? */
1079                 ast_cli(a->fd, "No call to flash\n");
1080                 return CLI_FAILURE;
1081         }
1082         o->hookstate = 0;
1083         if (o->owner)
1084                 ast_queue_frame(o->owner, &f);
1085         return CLI_SUCCESS;
1086 }
1087
1088 static char *console_dial(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1089 {
1090         char *s = NULL;
1091         char *mye = NULL, *myc = NULL;
1092         struct chan_oss_pvt *o = find_desc(oss_active);
1093
1094         if (cmd == CLI_INIT) {
1095                 e->command = "console dial";
1096                 e->usage =
1097                         "Usage: console dial [extension[@context]]\n"
1098                         "       Dials a given extension (and context if specified)\n";
1099                 return NULL;
1100         } else if (cmd == CLI_GENERATE)
1101                 return NULL;
1102
1103         if (a->argc > e->args + 1)
1104                 return CLI_SHOWUSAGE;
1105         if (o->owner) { /* already in a call */
1106                 int i;
1107                 struct ast_frame f = { AST_FRAME_DTMF, { 0 } };
1108                 const char *digits;
1109
1110                 if (a->argc == e->args) {       /* argument is mandatory here */
1111                         ast_cli(a->fd, "Already in a call. You can only dial digits until you hangup.\n");
1112                         return CLI_FAILURE;
1113                 }
1114                 digits = a->argv[e->args];
1115                 /* send the string one char at a time */
1116                 for (i = 0; i < strlen(digits); i++) {
1117                         f.subclass.integer = digits[i];
1118                         ast_queue_frame(o->owner, &f);
1119                 }
1120                 return CLI_SUCCESS;
1121         }
1122         /* if we have an argument split it into extension and context */
1123         if (a->argc == e->args + 1)
1124                 s = ast_ext_ctx(a->argv[e->args], &mye, &myc);
1125         /* supply default values if needed */
1126         if (mye == NULL)
1127                 mye = o->ext;
1128         if (myc == NULL)
1129                 myc = o->ctx;
1130         if (ast_exists_extension(NULL, myc, mye, 1, NULL)) {
1131                 o->hookstate = 1;
1132                 oss_new(o, mye, myc, AST_STATE_RINGING, NULL, NULL);
1133         } else
1134                 ast_cli(a->fd, "No such extension '%s' in context '%s'\n", mye, myc);
1135         if (s)
1136                 ast_free(s);
1137         return CLI_SUCCESS;
1138 }
1139
1140 static char *console_mute(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1141 {
1142         struct chan_oss_pvt *o = find_desc(oss_active);
1143         const char *s;
1144         int toggle = 0;
1145         
1146         if (cmd == CLI_INIT) {
1147                 e->command = "console {mute|unmute} [toggle]";
1148                 e->usage =
1149                         "Usage: console {mute|unmute} [toggle]\n"
1150                         "       Mute/unmute the microphone.\n";
1151                 return NULL;
1152         } else if (cmd == CLI_GENERATE)
1153                 return NULL;
1154
1155         if (a->argc > e->args)
1156                 return CLI_SHOWUSAGE;
1157         if (a->argc == e->args) {
1158                 if (strcasecmp(a->argv[e->args-1], "toggle"))
1159                         return CLI_SHOWUSAGE;
1160                 toggle = 1;
1161         }
1162         s = a->argv[e->args-2];
1163         if (!strcasecmp(s, "mute"))
1164                 o->mute = toggle ? !o->mute : 1;
1165         else if (!strcasecmp(s, "unmute"))
1166                 o->mute = toggle ? !o->mute : 0;
1167         else
1168                 return CLI_SHOWUSAGE;
1169         ast_cli(a->fd, "Console mic is %s\n", o->mute ? "off" : "on");
1170         return CLI_SUCCESS;
1171 }
1172
1173 static char *console_transfer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1174 {
1175         struct chan_oss_pvt *o = find_desc(oss_active);
1176         char *tmp, *ext, *ctx;
1177
1178         switch (cmd) {
1179         case CLI_INIT:
1180                 e->command = "console transfer";
1181                 e->usage =
1182                         "Usage: console transfer <extension>[@context]\n"
1183                         "       Transfers the currently connected call to the given extension (and\n"
1184                         "       context if specified)\n";
1185                 return NULL;
1186         case CLI_GENERATE:
1187                 return NULL;
1188         }
1189
1190         if (a->argc != 3)
1191                 return CLI_SHOWUSAGE;
1192         if (o == NULL)
1193                 return CLI_FAILURE;
1194         if (o->owner == NULL || !ast_channel_is_bridged(o->owner)) {
1195                 ast_cli(a->fd, "There is no call to transfer\n");
1196                 return CLI_SUCCESS;
1197         }
1198
1199         tmp = ast_ext_ctx(a->argv[2], &ext, &ctx);
1200         if (ctx == NULL) {                      /* supply default context if needed */
1201                 ctx = ast_strdupa(ast_channel_context(o->owner));
1202         }
1203         if (ast_bridge_transfer_blind(1, o->owner, ext, ctx, NULL, NULL) != AST_BRIDGE_TRANSFER_SUCCESS) {
1204                 ast_log(LOG_WARNING, "Unable to transfer call from channel %s\n", ast_channel_name(o->owner));
1205         }
1206         ast_free(tmp);
1207         return CLI_SUCCESS;
1208 }
1209
1210 static char *console_active(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1211 {
1212         switch (cmd) {
1213         case CLI_INIT:
1214                 e->command = "console {set|show} active [<device>]";
1215                 e->usage =
1216                         "Usage: console active [device]\n"
1217                         "       If used without a parameter, displays which device is the current\n"
1218                         "       console.  If a device is specified, the console sound device is changed to\n"
1219                         "       the device specified.\n";
1220                 return NULL;
1221         case CLI_GENERATE:
1222                 return NULL;
1223         }
1224
1225         if (a->argc == 3)
1226                 ast_cli(a->fd, "active console is [%s]\n", oss_active);
1227         else if (a->argc != 4)
1228                 return CLI_SHOWUSAGE;
1229         else {
1230                 struct chan_oss_pvt *o;
1231                 if (strcmp(a->argv[3], "show") == 0) {
1232                         for (o = oss_default.next; o; o = o->next)
1233                                 ast_cli(a->fd, "device [%s] exists\n", o->name);
1234                         return CLI_SUCCESS;
1235                 }
1236                 o = find_desc(a->argv[3]);
1237                 if (o == NULL)
1238                         ast_cli(a->fd, "No device [%s] exists\n", a->argv[3]);
1239                 else
1240                         oss_active = o->name;
1241         }
1242         return CLI_SUCCESS;
1243 }
1244
1245 /*!
1246  * \brief store the boost factor
1247  */
1248 static void store_boost(struct chan_oss_pvt *o, const char *s)
1249 {
1250         double boost = 0;
1251         if (sscanf(s, "%30lf", &boost) != 1) {
1252                 ast_log(LOG_WARNING, "invalid boost <%s>\n", s);
1253                 return;
1254         }
1255         if (boost < -BOOST_MAX) {
1256                 ast_log(LOG_WARNING, "boost %s too small, using %d\n", s, -BOOST_MAX);
1257                 boost = -BOOST_MAX;
1258         } else if (boost > BOOST_MAX) {
1259                 ast_log(LOG_WARNING, "boost %s too large, using %d\n", s, BOOST_MAX);
1260                 boost = BOOST_MAX;
1261         }
1262         boost = exp(log(10) * boost / 20) * BOOST_SCALE;
1263         o->boost = boost;
1264         ast_log(LOG_WARNING, "setting boost %s to %d\n", s, o->boost);
1265 }
1266
1267 static char *console_boost(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1268 {
1269         struct chan_oss_pvt *o = find_desc(oss_active);
1270
1271         switch (cmd) {
1272         case CLI_INIT:
1273                 e->command = "console boost";
1274                 e->usage =
1275                         "Usage: console boost [boost in dB]\n"
1276                         "       Sets or display mic boost in dB\n";
1277                 return NULL;
1278         case CLI_GENERATE:
1279                 return NULL;
1280         }
1281
1282         if (a->argc == 2)
1283                 ast_cli(a->fd, "boost currently %5.1f\n", 20 * log10(((double) o->boost / (double) BOOST_SCALE)));
1284         else if (a->argc == 3)
1285                 store_boost(o, a->argv[2]);
1286         return CLI_SUCCESS;
1287 }
1288
1289 static struct ast_cli_entry cli_oss[] = {
1290         AST_CLI_DEFINE(console_answer, "Answer an incoming console call"),
1291         AST_CLI_DEFINE(console_hangup, "Hangup a call on the console"),
1292         AST_CLI_DEFINE(console_flash, "Flash a call on the console"),
1293         AST_CLI_DEFINE(console_dial, "Dial an extension on the console"),
1294         AST_CLI_DEFINE(console_mute, "Disable/Enable mic input"),
1295         AST_CLI_DEFINE(console_transfer, "Transfer a call to a different extension"),   
1296         AST_CLI_DEFINE(console_cmd, "Generic console command"),
1297         AST_CLI_DEFINE(console_sendtext, "Send text to the remote device"),
1298         AST_CLI_DEFINE(console_autoanswer, "Sets/displays autoanswer"),
1299         AST_CLI_DEFINE(console_boost, "Sets/displays mic boost in dB"),
1300         AST_CLI_DEFINE(console_active, "Sets/displays active console"),
1301 };
1302
1303 /*!
1304  * store the mixer argument from the config file, filtering possibly
1305  * invalid or dangerous values (the string is used as argument for
1306  * system("mixer %s")
1307  */
1308 static void store_mixer(struct chan_oss_pvt *o, const char *s)
1309 {
1310         int i;
1311
1312         for (i = 0; i < strlen(s); i++) {
1313                 if (!isalnum(s[i]) && strchr(" \t-/", s[i]) == NULL) {
1314                         ast_log(LOG_WARNING, "Suspect char %c in mixer cmd, ignoring:\n\t%s\n", s[i], s);
1315                         return;
1316                 }
1317         }
1318         if (o->mixer_cmd)
1319                 ast_free(o->mixer_cmd);
1320         o->mixer_cmd = ast_strdup(s);
1321         ast_log(LOG_WARNING, "setting mixer %s\n", s);
1322 }
1323
1324 /*!
1325  * store the callerid components
1326  */
1327 static void store_callerid(struct chan_oss_pvt *o, const char *s)
1328 {
1329         ast_callerid_split(s, o->cid_name, sizeof(o->cid_name), o->cid_num, sizeof(o->cid_num));
1330 }
1331
1332 static void store_config_core(struct chan_oss_pvt *o, const char *var, const char *value)
1333 {
1334         CV_START(var, value);
1335
1336         /* handle jb conf */
1337         if (!ast_jb_read_conf(&global_jbconf, var, value))
1338                 return;
1339
1340         if (!console_video_config(&o->env, var, value))
1341                 return; /* matched there */
1342         CV_BOOL("autoanswer", o->autoanswer);
1343         CV_BOOL("autohangup", o->autohangup);
1344         CV_BOOL("overridecontext", o->overridecontext);
1345         CV_STR("device", o->device);
1346         CV_UINT("frags", o->frags);
1347         CV_UINT("debug", oss_debug);
1348         CV_UINT("queuesize", o->queuesize);
1349         CV_STR("context", o->ctx);
1350         CV_STR("language", o->language);
1351         CV_STR("mohinterpret", o->mohinterpret);
1352         CV_STR("extension", o->ext);
1353         CV_F("mixer", store_mixer(o, value));
1354         CV_F("callerid", store_callerid(o, value))  ;
1355         CV_F("boost", store_boost(o, value));
1356
1357         CV_END;
1358 }
1359
1360 /*!
1361  * grab fields from the config file, init the descriptor and open the device.
1362  */
1363 static struct chan_oss_pvt *store_config(struct ast_config *cfg, char *ctg)
1364 {
1365         struct ast_variable *v;
1366         struct chan_oss_pvt *o;
1367
1368         if (ctg == NULL) {
1369                 o = &oss_default;
1370                 ctg = "general";
1371         } else {
1372                 if (!(o = ast_calloc(1, sizeof(*o))))
1373                         return NULL;
1374                 *o = oss_default;
1375                 /* "general" is also the default thing */
1376                 if (strcmp(ctg, "general") == 0) {
1377                         o->name = ast_strdup("dsp");
1378                         oss_active = o->name;
1379                         goto openit;
1380                 }
1381                 o->name = ast_strdup(ctg);
1382         }
1383
1384         strcpy(o->mohinterpret, "default");
1385
1386         o->lastopen = ast_tvnow();      /* don't leave it 0 or tvdiff may wrap */
1387         /* fill other fields from configuration */
1388         for (v = ast_variable_browse(cfg, ctg); v; v = v->next) {
1389                 store_config_core(o, v->name, v->value);
1390         }
1391         if (ast_strlen_zero(o->device))
1392                 ast_copy_string(o->device, DEV_DSP, sizeof(o->device));
1393         if (o->mixer_cmd) {
1394                 char *cmd;
1395
1396                 if (ast_asprintf(&cmd, "mixer %s", o->mixer_cmd) >= 0) {
1397                         ast_log(LOG_WARNING, "running [%s]\n", cmd);
1398                         if (system(cmd) < 0) {
1399                                 ast_log(LOG_WARNING, "system() failed: %s\n", strerror(errno));
1400                         }
1401                         ast_free(cmd);
1402                 }
1403         }
1404
1405         /* if the config file requested to start the GUI, do it */
1406         if (get_gui_startup(o->env))
1407                 console_video_start(o->env, NULL);
1408
1409         if (o == &oss_default)          /* we are done with the default */
1410                 return NULL;
1411
1412 openit:
1413 #ifdef TRYOPEN
1414         if (setformat(o, O_RDWR) < 0) { /* open device */
1415                 ast_verb(1, "Device %s not detected\n", ctg);
1416                 ast_verb(1, "Turn off OSS support by adding " "'noload=chan_oss.so' in /etc/asterisk/modules.conf\n");
1417                 goto error;
1418         }
1419         if (o->duplex != M_FULL)
1420                 ast_log(LOG_WARNING, "XXX I don't work right with non " "full-duplex sound cards XXX\n");
1421 #endif /* TRYOPEN */
1422
1423         /* link into list of devices */
1424         if (o != &oss_default) {
1425                 o->next = oss_default.next;
1426                 oss_default.next = o;
1427         }
1428         return o;
1429
1430 #ifdef TRYOPEN
1431 error:
1432         if (o != &oss_default)
1433                 ast_free(o);
1434         return NULL;
1435 #endif
1436 }
1437
1438 static int unload_module(void)
1439 {
1440         struct chan_oss_pvt *o, *next;
1441
1442         ast_channel_unregister(&oss_tech);
1443         ast_cli_unregister_multiple(cli_oss, ARRAY_LEN(cli_oss));
1444
1445         o = oss_default.next;
1446         while (o) {
1447                 close(o->sounddev);
1448                 if (o->owner)
1449                         ast_softhangup(o->owner, AST_SOFTHANGUP_APPUNLOAD);
1450                 if (o->owner)
1451                         return -1;
1452                 next = o->next;
1453                 ast_free(o->name);
1454                 ast_free(o);
1455                 o = next;
1456         }
1457         ao2_cleanup(oss_tech.capabilities);
1458         oss_tech.capabilities = NULL;
1459
1460         return 0;
1461 }
1462
1463 /*!
1464  * \brief Load the module
1465  *
1466  * Module loading including tests for configuration or dependencies.
1467  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
1468  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
1469  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
1470  * configuration file or other non-critical problem return 
1471  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
1472  */
1473 static int load_module(void)
1474 {
1475         struct ast_config *cfg = NULL;
1476         char *ctg = NULL;
1477         struct ast_flags config_flags = { 0 };
1478
1479         /* Copy the default jb config over global_jbconf */
1480         memcpy(&global_jbconf, &default_jbconf, sizeof(struct ast_jb_conf));
1481
1482         /* load config file */
1483         if (!(cfg = ast_config_load(config, config_flags))) {
1484                 ast_log(LOG_NOTICE, "Unable to load config %s\n", config);
1485                 return AST_MODULE_LOAD_DECLINE;
1486         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
1487                 ast_log(LOG_ERROR, "Config file %s is in an invalid format.  Aborting.\n", config);
1488                 return AST_MODULE_LOAD_DECLINE;
1489         }
1490
1491         do {
1492                 store_config(cfg, ctg);
1493         } while ( (ctg = ast_category_browse(cfg, ctg)) != NULL);
1494
1495         ast_config_destroy(cfg);
1496
1497         if (find_desc(oss_active) == NULL) {
1498                 ast_log(LOG_NOTICE, "Device %s not found\n", oss_active);
1499                 /* XXX we could default to 'dsp' perhaps ? */
1500                 unload_module();
1501                 return AST_MODULE_LOAD_DECLINE;
1502         }
1503
1504         if (!(oss_tech.capabilities = ast_format_cap_alloc(0))) {
1505                 return AST_MODULE_LOAD_DECLINE;
1506         }
1507         ast_format_cap_append(oss_tech.capabilities, ast_format_slin, 0);
1508
1509         /* TODO XXX CONSOLE VIDEO IS DISABLE UNTIL IT HAS A MAINTAINER
1510          * add console_video_formats to oss_tech.capabilities once this occurs. */
1511
1512         if (ast_channel_register(&oss_tech)) {
1513                 ast_log(LOG_ERROR, "Unable to register channel type 'OSS'\n");
1514                 return AST_MODULE_LOAD_DECLINE;
1515         }
1516
1517         ast_cli_register_multiple(cli_oss, ARRAY_LEN(cli_oss));
1518
1519         return AST_MODULE_LOAD_SUCCESS;
1520 }
1521
1522 AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "OSS Console Channel Driver");
1523