Numerous documentation updates.
[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  * \par See also
31  * \arg \ref Config_oss
32  *
33  * \ingroup channel_drivers
34  */
35
36 /*** MODULEINFO
37         <depend>oss</depend>
38  ***/
39
40 #include "asterisk.h"
41
42 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
43
44 #include <ctype.h>              /* isalnum() used here */
45 #include <math.h>
46 #include <sys/ioctl.h>          
47
48 #ifdef __linux
49 #include <linux/soundcard.h>
50 #elif defined(__FreeBSD__) || defined(__CYGWIN__)
51 #include <sys/soundcard.h>
52 #else
53 #include <soundcard.h>
54 #endif
55
56 #include "asterisk/channel.h"
57 #include "asterisk/file.h"
58 #include "asterisk/callerid.h"
59 #include "asterisk/module.h"
60 #include "asterisk/pbx.h"
61 #include "asterisk/cli.h"
62 #include "asterisk/causes.h"
63 #include "asterisk/musiconhold.h"
64 #include "asterisk/app.h"
65
66 #include "console_video.h"
67
68 /*! Global jitterbuffer configuration - by default, jb is disabled */
69 static struct ast_jb_conf default_jbconf =
70 {
71         .flags = 0,
72         .max_size = -1,
73         .resync_threshold = -1,
74         .impl = "",
75 };
76 static struct ast_jb_conf global_jbconf;
77
78 /*
79  * Basic mode of operation:
80  *
81  * we have one keyboard (which receives commands from the keyboard)
82  * and multiple headset's connected to audio cards.
83  * Cards/Headsets are named as the sections of oss.conf.
84  * The section called [general] contains the default parameters.
85  *
86  * At any time, the keyboard is attached to one card, and you
87  * can switch among them using the command 'console foo'
88  * where 'foo' is the name of the card you want.
89  *
90  * oss.conf parameters are
91 START_CONFIG
92
93 [general]
94     ; General config options, with default values shown.
95     ; You should use one section per device, with [general] being used
96     ; for the first device and also as a template for other devices.
97     ;
98     ; All but 'debug' can go also in the device-specific sections.
99     ;
100     ; debug = 0x0               ; misc debug flags, default is 0
101
102     ; Set the device to use for I/O
103     ; device = /dev/dsp
104
105     ; Optional mixer command to run upon startup (e.g. to set
106     ; volume levels, mutes, etc.
107     ; mixer =
108
109     ; Software mic volume booster (or attenuator), useful for sound
110     ; cards or microphones with poor sensitivity. The volume level
111     ; is in dB, ranging from -20.0 to +20.0
112     ; boost = n                 ; mic volume boost in dB
113
114     ; Set the callerid for outgoing calls
115     ; callerid = John Doe <555-1234>
116
117     ; autoanswer = no           ; no autoanswer on call
118     ; autohangup = yes          ; hangup when other party closes
119     ; extension = s             ; default extension to call
120     ; context = default         ; default context for outgoing calls
121     ; language = ""             ; default language
122
123     ; Default Music on Hold class to use when this channel is placed on hold in
124     ; the case that the music class is not set on the channel with
125     ; Set(CHANNEL(musicclass)=whatever) in the dialplan and the peer channel
126     ; putting this one on hold did not suggest a class to use.
127     ;
128     ; mohinterpret=default
129
130     ; If you set overridecontext to 'yes', then the whole dial string
131     ; will be interpreted as an extension, which is extremely useful
132     ; to dial SIP, IAX and other extensions which use the '@' character.
133     ; The default is 'no' just for backward compatibility, but the
134     ; suggestion is to change it.
135     ; overridecontext = no      ; if 'no', the last @ will start the context
136                                 ; if 'yes' the whole string is an extension.
137
138     ; low level device parameters in case you have problems with the
139     ; device driver on your operating system. You should not touch these
140     ; unless you know what you are doing.
141     ; queuesize = 10            ; frames in device driver
142     ; frags = 8                 ; argument to SETFRAGMENT
143
144     ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
145     ; jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of an
146                                   ; OSS channel. Defaults to "no". An enabled jitterbuffer will
147                                   ; be used only if the sending side can create and the receiving
148                                   ; side can not accept jitter. The OSS channel can't accept jitter,
149                                   ; thus an enabled jitterbuffer on the receive OSS side will always
150                                   ; be used if the sending side can create jitter.
151
152     ; jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
153
154     ; jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
155                                   ; resynchronized. Useful to improve the quality of the voice, with
156                                   ; big jumps in/broken timestamps, usualy sent from exotic devices
157                                   ; and programs. Defaults to 1000.
158
159     ; jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of an OSS
160                                   ; channel. Two implementations are currenlty available - "fixed"
161                                   ; (with size always equals to jbmax-size) and "adaptive" (with
162                                   ; variable size, actually the new jb of IAX2). Defaults to fixed.
163
164     ; jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
165     ;-----------------------------------------------------------------------------------
166
167 [card1]
168     ; device = /dev/dsp1        ; alternate device
169
170 END_CONFIG
171
172 .. and so on for the other cards.
173
174  */
175
176 /*
177  * The following parameters are used in the driver:
178  *
179  *  FRAME_SIZE  the size of an audio frame, in samples.
180  *              160 is used almost universally, so you should not change it.
181  *
182  *  FRAGS       the argument for the SETFRAGMENT ioctl.
183  *              Overridden by the 'frags' parameter in oss.conf
184  *
185  *              Bits 0-7 are the base-2 log of the device's block size,
186  *              bits 16-31 are the number of blocks in the driver's queue.
187  *              There are a lot of differences in the way this parameter
188  *              is supported by different drivers, so you may need to
189  *              experiment a bit with the value.
190  *              A good default for linux is 30 blocks of 64 bytes, which
191  *              results in 6 frames of 320 bytes (160 samples).
192  *              FreeBSD works decently with blocks of 256 or 512 bytes,
193  *              leaving the number unspecified.
194  *              Note that this only refers to the device buffer size,
195  *              this module will then try to keep the lenght of audio
196  *              buffered within small constraints.
197  *
198  *  QUEUE_SIZE  The max number of blocks actually allowed in the device
199  *              driver's buffer, irrespective of the available number.
200  *              Overridden by the 'queuesize' parameter in oss.conf
201  *
202  *              Should be >=2, and at most as large as the hw queue above
203  *              (otherwise it will never be full).
204  */
205
206 #define FRAME_SIZE      160
207 #define QUEUE_SIZE      10
208
209 #if defined(__FreeBSD__)
210 #define FRAGS   0x8
211 #else
212 #define FRAGS   ( ( (6 * 5) << 16 ) | 0x6 )
213 #endif
214
215 /*
216  * XXX text message sizes are probably 256 chars, but i am
217  * not sure if there is a suitable definition anywhere.
218  */
219 #define TEXT_SIZE       256
220
221 #if 0
222 #define TRYOPEN 1                               /* try to open on startup */
223 #endif
224 #define O_CLOSE 0x444                   /* special 'close' mode for device */
225 /* Which device to use */
226 #if defined( __OpenBSD__ ) || defined( __NetBSD__ )
227 #define DEV_DSP "/dev/audio"
228 #else
229 #define DEV_DSP "/dev/dsp"
230 #endif
231
232 #ifndef MIN
233 #define MIN(a,b) ((a) < (b) ? (a) : (b))
234 #endif
235 #ifndef MAX
236 #define MAX(a,b) ((a) > (b) ? (a) : (b))
237 #endif
238
239 static char *config = "oss.conf";       /* default config file */
240
241 static int oss_debug;
242
243 /*!
244  * \brief descriptor for one of our channels.
245  *
246  * There is one used for 'default' values (from the [general] entry in
247  * the configuration file), and then one instance for each device
248  * (the default is cloned from [general], others are only created
249  * if the relevant section exists).
250  */
251 struct chan_oss_pvt {
252         struct chan_oss_pvt *next;
253
254         char *name;
255         int total_blocks;                       /*!< total blocks in the output device */
256         int sounddev;
257         enum { M_UNSET, M_FULL, M_READ, M_WRITE } duplex;
258         int autoanswer;
259         int autohangup;
260         int hookstate;
261         char *mixer_cmd;                        /*!< initial command to issue to the mixer */
262         unsigned int queuesize;         /*!< max fragments in queue */
263         unsigned int frags;                     /*!< parameter for SETFRAGMENT */
264
265         int warned;                                     /*!< various flags used for warnings */
266 #define WARN_used_blocks        1
267 #define WARN_speed              2
268 #define WARN_frag               4
269         int w_errors;                           /*!< overfull in the write path */
270         struct timeval lastopen;
271
272         int overridecontext;
273         int mute;
274
275         /*! boost support. BOOST_SCALE * 10 ^(BOOST_MAX/20) must
276          *  be representable in 16 bits to avoid overflows.
277          */
278 #define BOOST_SCALE     (1<<9)
279 #define BOOST_MAX       40                      /*!< slightly less than 7 bits */
280         int boost;                                      /*!< input boost, scaled by BOOST_SCALE */
281         char device[64];                        /*!< device to open */
282
283         pthread_t sthread;
284
285         struct ast_channel *owner;
286
287         struct video_desc *env;                 /*!< parameters for video support */
288
289         char ext[AST_MAX_EXTENSION];
290         char ctx[AST_MAX_CONTEXT];
291         char language[MAX_LANGUAGE];
292         char cid_name[256];                     /*XXX */
293         char cid_num[256];                      /*XXX */
294         char mohinterpret[MAX_MUSICCLASS];
295
296         /*! buffers used in oss_write */
297         char oss_write_buf[FRAME_SIZE * 2];
298         int oss_write_dst;
299         /*! buffers used in oss_read - AST_FRIENDLY_OFFSET space for headers
300          *  plus enough room for a full frame
301          */
302         char oss_read_buf[FRAME_SIZE * 2 + AST_FRIENDLY_OFFSET];
303         int readpos;                            /*!< read position above */
304         struct ast_frame read_f;        /*!< returned by oss_read */
305 };
306
307 /*! forward declaration */
308 static struct chan_oss_pvt *find_desc(char *dev);
309
310 static char *oss_active;         /*!< the active device */
311
312 /*! \brief return the pointer to the video descriptor */
313 struct video_desc *get_video_desc(struct ast_channel *c)
314 {
315         struct chan_oss_pvt *o = c ? c->tech_pvt : find_desc(oss_active);
316         return o ? o->env : NULL;
317 }
318 static struct chan_oss_pvt oss_default = {
319         .sounddev = -1,
320         .duplex = M_UNSET,                      /* XXX check this */
321         .autoanswer = 1,
322         .autohangup = 1,
323         .queuesize = QUEUE_SIZE,
324         .frags = FRAGS,
325         .ext = "s",
326         .ctx = "default",
327         .readpos = AST_FRIENDLY_OFFSET, /* start here on reads */
328         .lastopen = { 0, 0 },
329         .boost = BOOST_SCALE,
330 };
331
332
333 static int setformat(struct chan_oss_pvt *o, int mode);
334
335 static struct ast_channel *oss_request(const char *type, int format, void *data
336 , int *cause);
337 static int oss_digit_begin(struct ast_channel *c, char digit);
338 static int oss_digit_end(struct ast_channel *c, char digit, unsigned int duration);
339 static int oss_text(struct ast_channel *c, const char *text);
340 static int oss_hangup(struct ast_channel *c);
341 static int oss_answer(struct ast_channel *c);
342 static struct ast_frame *oss_read(struct ast_channel *chan);
343 static int oss_call(struct ast_channel *c, char *dest, int timeout);
344 static int oss_write(struct ast_channel *chan, struct ast_frame *f);
345 static int oss_indicate(struct ast_channel *chan, int cond, const void *data, size_t datalen);
346 static int oss_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
347 static char tdesc[] = "OSS Console Channel Driver";
348
349 /* cannot do const because need to update some fields at runtime */
350 static struct ast_channel_tech oss_tech = {
351         .type = "Console",
352         .description = tdesc,
353         .capabilities = AST_FORMAT_SLINEAR, /* overwritten later */
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(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 audio device to mono\n");
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, char *dest, int timeout)
599 {
600         struct chan_oss_pvt *o = c->tech_pvt;
601         struct ast_frame f = { 0, };
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", dest, c->cid.cid_dnid, c->cid.cid_rdnis, c->cid.cid_name, c->cid.cid_num);
611         if (!ast_strlen_zero(args.flags) && strcasecmp(args.flags, "answer") == 0) {
612                 f.frametype = AST_FRAME_CONTROL;
613                 f.subclass = AST_CONTROL_ANSWER;
614                 ast_queue_frame(c, &f);
615         } else if (!ast_strlen_zero(args.flags) && strcasecmp(args.flags, "noanswer") == 0) {
616                 f.frametype = AST_FRAME_CONTROL;
617                 f.subclass = AST_CONTROL_RINGING;
618                 ast_queue_frame(c, &f);
619                 ast_indicate(c, AST_CONTROL_RINGING);
620         } else if (o->autoanswer) {
621                 ast_verbose(" << Auto-answered >> \n");
622                 f.frametype = AST_FRAME_CONTROL;
623                 f.subclass = AST_CONTROL_ANSWER;
624                 ast_queue_frame(c, &f);
625         } else {
626                 ast_verbose("<< Type 'answer' to answer, or use 'autoanswer' for future calls >> \n");
627                 f.frametype = AST_FRAME_CONTROL;
628                 f.subclass = AST_CONTROL_RINGING;
629                 ast_queue_frame(c, &f);
630                 ast_indicate(c, AST_CONTROL_RINGING);
631         }
632         return 0;
633 }
634
635 /*!
636  * \brief remote side answered the phone
637  */
638 static int oss_answer(struct ast_channel *c)
639 {
640         ast_verbose(" << Console call has been answered >> \n");
641         ast_setstate(c, AST_STATE_UP);
642         return 0;
643 }
644
645 static int oss_hangup(struct ast_channel *c)
646 {
647         struct chan_oss_pvt *o = c->tech_pvt;
648
649         c->tech_pvt = NULL;
650         o->owner = NULL;
651         ast_verbose(" << Hangup on console >> \n");
652         console_video_uninit(o->env);
653         ast_module_unref(ast_module_info->self);
654         if (o->hookstate) {
655                 if (o->autoanswer || o->autohangup) {
656                         /* Assume auto-hangup too */
657                         o->hookstate = 0;
658                         setformat(o, O_CLOSE);
659                 }
660         }
661         return 0;
662 }
663
664 /*! \brief used for data coming from the network */
665 static int oss_write(struct ast_channel *c, struct ast_frame *f)
666 {
667         int src;
668         struct chan_oss_pvt *o = c->tech_pvt;
669
670         /*
671          * we could receive a block which is not a multiple of our
672          * FRAME_SIZE, so buffer it locally and write to the device
673          * in FRAME_SIZE chunks.
674          * Keep the residue stored for future use.
675          */
676         src = 0;                                        /* read position into f->data */
677         while (src < f->datalen) {
678                 /* Compute spare room in the buffer */
679                 int l = sizeof(o->oss_write_buf) - o->oss_write_dst;
680
681                 if (f->datalen - src >= l) {    /* enough to fill a frame */
682                         memcpy(o->oss_write_buf + o->oss_write_dst, f->data.ptr + src, l);
683                         soundcard_writeframe(o, (short *) o->oss_write_buf);
684                         src += l;
685                         o->oss_write_dst = 0;
686                 } else {                                /* copy residue */
687                         l = f->datalen - src;
688                         memcpy(o->oss_write_buf + o->oss_write_dst, f->data.ptr + src, l);
689                         src += l;                       /* but really, we are done */
690                         o->oss_write_dst += l;
691                 }
692         }
693         return 0;
694 }
695
696 static struct ast_frame *oss_read(struct ast_channel *c)
697 {
698         int res;
699         struct chan_oss_pvt *o = c->tech_pvt;
700         struct ast_frame *f = &o->read_f;
701
702         /* XXX can be simplified returning &ast_null_frame */
703         /* prepare a NULL frame in case we don't have enough data to return */
704         memset(f, '\0', sizeof(struct ast_frame));
705         f->frametype = AST_FRAME_NULL;
706         f->src = oss_tech.type;
707
708         res = read(o->sounddev, o->oss_read_buf + o->readpos, sizeof(o->oss_read_buf) - o->readpos);
709         if (res < 0)                            /* audio data not ready, return a NULL frame */
710                 return f;
711
712         o->readpos += res;
713         if (o->readpos < sizeof(o->oss_read_buf))       /* not enough samples */
714                 return f;
715
716         if (o->mute)
717                 return f;
718
719         o->readpos = AST_FRIENDLY_OFFSET;       /* reset read pointer for next frame */
720         if (c->_state != AST_STATE_UP)  /* drop data if frame is not up */
721                 return f;
722         /* ok we can build and deliver the frame to the caller */
723         f->frametype = AST_FRAME_VOICE;
724         f->subclass = AST_FORMAT_SLINEAR;
725         f->samples = FRAME_SIZE;
726         f->datalen = FRAME_SIZE * 2;
727         f->data.ptr = o->oss_read_buf + AST_FRIENDLY_OFFSET;
728         if (o->boost != BOOST_SCALE) {  /* scale and clip values */
729                 int i, x;
730                 int16_t *p = (int16_t *) f->data.ptr;
731                 for (i = 0; i < f->samples; i++) {
732                         x = (p[i] * o->boost) / BOOST_SCALE;
733                         if (x > 32767)
734                                 x = 32767;
735                         else if (x < -32768)
736                                 x = -32768;
737                         p[i] = x;
738                 }
739         }
740
741         f->offset = AST_FRIENDLY_OFFSET;
742         return f;
743 }
744
745 static int oss_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
746 {
747         struct chan_oss_pvt *o = newchan->tech_pvt;
748         o->owner = newchan;
749         return 0;
750 }
751
752 static int oss_indicate(struct ast_channel *c, int cond, const void *data, size_t datalen)
753 {
754         struct chan_oss_pvt *o = c->tech_pvt;
755         int res = 0;
756
757         switch (cond) {
758         case AST_CONTROL_BUSY:
759         case AST_CONTROL_CONGESTION:
760         case AST_CONTROL_RINGING:
761         case -1:
762                 res = -1;
763                 break;
764         case AST_CONTROL_PROGRESS:
765         case AST_CONTROL_PROCEEDING:
766         case AST_CONTROL_VIDUPDATE:
767         case AST_CONTROL_SRCUPDATE:
768                 break;
769         case AST_CONTROL_HOLD:
770                 ast_verbose(" << Console Has Been Placed on Hold >> \n");
771                 ast_moh_start(c, data, o->mohinterpret);
772                 break;
773         case AST_CONTROL_UNHOLD:
774                 ast_verbose(" << Console Has Been Retrieved from Hold >> \n");
775                 ast_moh_stop(c);
776                 break;
777         default:
778                 ast_log(LOG_WARNING, "Don't know how to display condition %d on %s\n", cond, c->name);
779                 return -1;
780         }
781
782         return res;
783 }
784
785 /*!
786  * \brief allocate a new channel.
787  */
788 static struct ast_channel *oss_new(struct chan_oss_pvt *o, char *ext, char *ctx, int state)
789 {
790         struct ast_channel *c;
791
792         c = ast_channel_alloc(1, state, o->cid_num, o->cid_name, "", ext, ctx, 0, "Console/%s", o->device + 5);
793         if (c == NULL)
794                 return NULL;
795         c->tech = &oss_tech;
796         if (o->sounddev < 0)
797                 setformat(o, O_RDWR);
798         ast_channel_set_fd(c, 0, o->sounddev); /* -1 if device closed, override later */
799         c->nativeformats = AST_FORMAT_SLINEAR;
800         /* if the console makes the call, add video to the offer */
801         if (state == AST_STATE_RINGING)
802                 c->nativeformats |= console_video_formats;
803
804         c->readformat = AST_FORMAT_SLINEAR;
805         c->writeformat = AST_FORMAT_SLINEAR;
806         c->tech_pvt = o;
807
808         if (!ast_strlen_zero(o->language))
809                 ast_string_field_set(c, language, o->language);
810         /* Don't use ast_set_callerid() here because it will
811          * generate a needless NewCallerID event */
812         c->cid.cid_ani = ast_strdup(o->cid_num);
813         if (!ast_strlen_zero(ext))
814                 c->cid.cid_dnid = ast_strdup(ext);
815
816         o->owner = c;
817         ast_module_ref(ast_module_info->self);
818         ast_jb_configure(c, &global_jbconf);
819         if (state != AST_STATE_DOWN) {
820                 if (ast_pbx_start(c)) {
821                         ast_log(LOG_WARNING, "Unable to start PBX on %s\n", c->name);
822                         ast_hangup(c);
823                         o->owner = c = NULL;
824                         /* XXX what about the channel itself ? */
825                 }
826         }
827         console_video_start(get_video_desc(c), c); /* XXX cleanup */
828
829         return c;
830 }
831
832 static struct ast_channel *oss_request(const char *type, int format, void *data, int *cause)
833 {
834         struct ast_channel *c;
835         struct chan_oss_pvt *o;
836         AST_DECLARE_APP_ARGS(args,
837                 AST_APP_ARG(name);
838                 AST_APP_ARG(flags);
839         );
840         char *parse = ast_strdupa(data);
841
842         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
843         o = find_desc(args.name);
844
845         ast_log(LOG_WARNING, "oss_request ty <%s> data 0x%p <%s>\n", type, data, (char *) data);
846         if (o == NULL) {
847                 ast_log(LOG_NOTICE, "Device %s not found\n", args.name);
848                 /* XXX we could default to 'dsp' perhaps ? */
849                 return NULL;
850         }
851         if ((format & AST_FORMAT_SLINEAR) == 0) {
852                 ast_log(LOG_NOTICE, "Format 0x%x unsupported\n", format);
853                 return NULL;
854         }
855         if (o->owner) {
856                 ast_log(LOG_NOTICE, "Already have a call (chan %p) on the OSS channel\n", o->owner);
857                 *cause = AST_CAUSE_BUSY;
858                 return NULL;
859         }
860         c = oss_new(o, NULL, NULL, AST_STATE_DOWN);
861         if (c == NULL) {
862                 ast_log(LOG_WARNING, "Unable to create new OSS channel\n");
863                 return NULL;
864         }
865         return c;
866 }
867
868 static void store_config_core(struct chan_oss_pvt *o, const char *var, const char *value);
869
870 /*! Generic console command handler. Basically a wrapper for a subset
871  *  of config file options which are also available from the CLI
872  */
873 static char *console_cmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
874 {
875         struct chan_oss_pvt *o = find_desc(oss_active);
876         const char *var, *value;
877         switch (cmd) {
878         case CLI_INIT:
879                 e->command = CONSOLE_VIDEO_CMDS;
880                 e->usage = 
881                         "Usage: " CONSOLE_VIDEO_CMDS "...\n"
882                         "       Generic handler for console commands.\n";
883                 return NULL;
884
885         case CLI_GENERATE:
886                 return NULL;
887         }
888
889         if (a->argc < e->args)
890                 return CLI_SHOWUSAGE;
891         if (o == NULL) {
892                 ast_log(LOG_WARNING, "Cannot find device %s (should not happen!)\n",
893                         oss_active);
894                 return CLI_FAILURE;
895         }
896         var = a->argv[e->args-1];
897         value = a->argc > e->args ? a->argv[e->args] : NULL;
898         if (value)      /* handle setting */
899                 store_config_core(o, var, value);
900         if (!console_video_cli(o->env, var, a->fd))     /* print video-related values */
901                 return CLI_SUCCESS;
902         /* handle other values */
903         if (!strcasecmp(var, "device")) {
904                 ast_cli(a->fd, "device is [%s]\n", o->device);
905         }
906         return CLI_SUCCESS;
907 }
908
909 static char *console_autoanswer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
910 {
911         struct chan_oss_pvt *o = find_desc(oss_active);
912
913         switch (cmd) {
914         case CLI_INIT:
915                 e->command = "console {set|show} autoanswer [on|off]";
916                 e->usage =
917                         "Usage: console {set|show} autoanswer [on|off]\n"
918                         "       Enables or disables autoanswer feature.  If used without\n"
919                         "       argument, displays the current on/off status of autoanswer.\n"
920                         "       The default value of autoanswer is in 'oss.conf'.\n";
921                 return NULL;
922
923         case CLI_GENERATE:
924                 return NULL;
925         }
926
927         if (a->argc == e->args - 1) {
928                 ast_cli(a->fd, "Auto answer is %s.\n", o->autoanswer ? "on" : "off");
929                 return CLI_SUCCESS;
930         }
931         if (a->argc != e->args)
932                 return CLI_SHOWUSAGE;
933         if (o == NULL) {
934                 ast_log(LOG_WARNING, "Cannot find device %s (should not happen!)\n",
935                     oss_active);
936                 return CLI_FAILURE;
937         }
938         if (!strcasecmp(a->argv[e->args-1], "on"))
939                 o->autoanswer = 1;
940         else if (!strcasecmp(a->argv[e->args - 1], "off"))
941                 o->autoanswer = 0;
942         else
943                 return CLI_SHOWUSAGE;
944         return CLI_SUCCESS;
945 }
946
947 /*! \brief helper function for the answer key/cli command */
948 static char *console_do_answer(int fd)
949 {
950         struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_ANSWER };
951         struct chan_oss_pvt *o = find_desc(oss_active);
952         if (!o->owner) {
953                 if (fd > -1)
954                         ast_cli(fd, "No one is calling us\n");
955                 return CLI_FAILURE;
956         }
957         o->hookstate = 1;
958         ast_queue_frame(o->owner, &f);
959         return CLI_SUCCESS;
960 }
961
962 /*!
963  * \brief answer command from the console
964  */
965 static char *console_answer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
966 {
967         switch (cmd) {
968         case CLI_INIT:
969                 e->command = "console answer";
970                 e->usage =
971                         "Usage: console answer\n"
972                         "       Answers an incoming call on the console (OSS) channel.\n";
973                 return NULL;
974
975         case CLI_GENERATE:
976                 return NULL;    /* no completion */
977         }
978         if (a->argc != e->args)
979                 return CLI_SHOWUSAGE;
980         return console_do_answer(a->fd);
981 }
982
983 /*!
984  * \brief Console send text CLI command
985  *
986  * \note concatenate all arguments into a single string. argv is NULL-terminated
987  * so we can use it right away
988  */
989 static char *console_sendtext(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
990 {
991         struct chan_oss_pvt *o = find_desc(oss_active);
992         char buf[TEXT_SIZE];
993
994         if (cmd == CLI_INIT) {
995                 e->command = "console send text";
996                 e->usage =
997                         "Usage: console send text <message>\n"
998                         "       Sends a text message for display on the remote terminal.\n";
999                 return NULL;
1000         } else if (cmd == CLI_GENERATE)
1001                 return NULL;
1002
1003         if (a->argc < e->args + 1)
1004                 return CLI_SHOWUSAGE;
1005         if (!o->owner) {
1006                 ast_cli(a->fd, "Not in a call\n");
1007                 return CLI_FAILURE;
1008         }
1009         ast_join(buf, sizeof(buf) - 1, a->argv + e->args);
1010         if (!ast_strlen_zero(buf)) {
1011                 struct ast_frame f = { 0, };
1012                 int i = strlen(buf);
1013                 buf[i] = '\n';
1014                 f.frametype = AST_FRAME_TEXT;
1015                 f.subclass = 0;
1016                 f.data.ptr = buf;
1017                 f.datalen = i + 1;
1018                 ast_queue_frame(o->owner, &f);
1019         }
1020         return CLI_SUCCESS;
1021 }
1022
1023 static char *console_hangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1024 {
1025         struct chan_oss_pvt *o = find_desc(oss_active);
1026
1027         if (cmd == CLI_INIT) {
1028                 e->command = "console hangup";
1029                 e->usage =
1030                         "Usage: console hangup\n"
1031                         "       Hangs up any call currently placed on the console.\n";
1032                 return NULL;
1033         } else if (cmd == CLI_GENERATE)
1034                 return NULL;
1035
1036         if (a->argc != e->args)
1037                 return CLI_SHOWUSAGE;
1038         if (!o->owner && !o->hookstate) { /* XXX maybe only one ? */
1039                 ast_cli(a->fd, "No call to hang up\n");
1040                 return CLI_FAILURE;
1041         }
1042         o->hookstate = 0;
1043         if (o->owner)
1044                 ast_queue_hangup_with_cause(o->owner, AST_CAUSE_NORMAL_CLEARING);
1045         setformat(o, O_CLOSE);
1046         return CLI_SUCCESS;
1047 }
1048
1049 static char *console_flash(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1050 {
1051         struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_FLASH };
1052         struct chan_oss_pvt *o = find_desc(oss_active);
1053
1054         if (cmd == CLI_INIT) {
1055                 e->command = "console flash";
1056                 e->usage =
1057                         "Usage: console flash\n"
1058                         "       Flashes the call currently placed on the console.\n";
1059                 return NULL;
1060         } else if (cmd == CLI_GENERATE)
1061                 return NULL;
1062
1063         if (a->argc != e->args)
1064                 return CLI_SHOWUSAGE;
1065         if (!o->owner) {                        /* XXX maybe !o->hookstate too ? */
1066                 ast_cli(a->fd, "No call to flash\n");
1067                 return CLI_FAILURE;
1068         }
1069         o->hookstate = 0;
1070         if (o->owner)                           /* XXX must be true, right ? */
1071                 ast_queue_frame(o->owner, &f);
1072         return CLI_SUCCESS;
1073 }
1074
1075 static char *console_dial(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1076 {
1077         char *s = NULL, *mye = NULL, *myc = NULL;
1078         struct chan_oss_pvt *o = find_desc(oss_active);
1079
1080         if (cmd == CLI_INIT) {
1081                 e->command = "console dial";
1082                 e->usage =
1083                         "Usage: console dial [extension[@context]]\n"
1084                         "       Dials a given extension (and context if specified)\n";
1085                 return NULL;
1086         } else if (cmd == CLI_GENERATE)
1087                 return NULL;
1088
1089         if (a->argc > e->args + 1)
1090                 return CLI_SHOWUSAGE;
1091         if (o->owner) { /* already in a call */
1092                 int i;
1093                 struct ast_frame f = { AST_FRAME_DTMF, 0 };
1094
1095                 if (a->argc == e->args) {       /* argument is mandatory here */
1096                         ast_cli(a->fd, "Already in a call. You can only dial digits until you hangup.\n");
1097                         return CLI_FAILURE;
1098                 }
1099                 s = a->argv[e->args];
1100                 /* send the string one char at a time */
1101                 for (i = 0; i < strlen(s); i++) {
1102                         f.subclass = s[i];
1103                         ast_queue_frame(o->owner, &f);
1104                 }
1105                 return CLI_SUCCESS;
1106         }
1107         /* if we have an argument split it into extension and context */
1108         if (a->argc == e->args + 1)
1109                 s = ast_ext_ctx(a->argv[e->args], &mye, &myc);
1110         /* supply default values if needed */
1111         if (mye == NULL)
1112                 mye = o->ext;
1113         if (myc == NULL)
1114                 myc = o->ctx;
1115         if (ast_exists_extension(NULL, myc, mye, 1, NULL)) {
1116                 o->hookstate = 1;
1117                 oss_new(o, mye, myc, AST_STATE_RINGING);
1118         } else
1119                 ast_cli(a->fd, "No such extension '%s' in context '%s'\n", mye, myc);
1120         if (s)
1121                 ast_free(s);
1122         return CLI_SUCCESS;
1123 }
1124
1125 static char *console_mute(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1126 {
1127         struct chan_oss_pvt *o = find_desc(oss_active);
1128         char *s;
1129         int toggle = 0;
1130         
1131         if (cmd == CLI_INIT) {
1132                 e->command = "console {mute|unmute} [toggle]";
1133                 e->usage =
1134                         "Usage: console {mute|unmute} [toggle]\n"
1135                         "       Mute/unmute the microphone.\n";
1136                 return NULL;
1137         } else if (cmd == CLI_GENERATE)
1138                 return NULL;
1139
1140         if (a->argc > e->args)
1141                 return CLI_SHOWUSAGE;
1142         if (a->argc == e->args) {
1143                 if (strcasecmp(a->argv[e->args-1], "toggle"))
1144                         return CLI_SHOWUSAGE;
1145                 toggle = 1;
1146         }
1147         s = a->argv[e->args-2];
1148         if (!strcasecmp(s, "mute"))
1149                 o->mute = toggle ? ~o->mute : 1;
1150         else if (!strcasecmp(s, "unmute"))
1151                 o->mute = toggle ? ~o->mute : 0;
1152         else
1153                 return CLI_SHOWUSAGE;
1154         ast_cli(a->fd, "Console mic is %s\n", o->mute ? "off" : "on");
1155         return CLI_SUCCESS;
1156 }
1157
1158 static char *console_transfer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1159 {
1160         struct chan_oss_pvt *o = find_desc(oss_active);
1161         struct ast_channel *b = NULL;
1162         char *tmp, *ext, *ctx;
1163
1164         switch (cmd) {
1165         case CLI_INIT:
1166                 e->command = "console transfer";
1167                 e->usage =
1168                         "Usage: console transfer <extension>[@context]\n"
1169                         "       Transfers the currently connected call to the given extension (and\n"
1170                         "       context if specified)\n";
1171                 return NULL;
1172         case CLI_GENERATE:
1173                 return NULL;
1174         }
1175
1176         if (a->argc != 3)
1177                 return CLI_SHOWUSAGE;
1178         if (o == NULL)
1179                 return CLI_FAILURE;
1180         if (o->owner == NULL || (b = ast_bridged_channel(o->owner)) == NULL) {
1181                 ast_cli(a->fd, "There is no call to transfer\n");
1182                 return CLI_SUCCESS;
1183         }
1184
1185         tmp = ast_ext_ctx(a->argv[2], &ext, &ctx);
1186         if (ctx == NULL)                        /* supply default context if needed */
1187                 ctx = o->owner->context;
1188         if (!ast_exists_extension(b, ctx, ext, 1, b->cid.cid_num))
1189                 ast_cli(a->fd, "No such extension exists\n");
1190         else {
1191                 ast_cli(a->fd, "Whee, transferring %s to %s@%s.\n", b->name, ext, ctx);
1192                 if (ast_async_goto(b, ctx, ext, 1))
1193                         ast_cli(a->fd, "Failed to transfer :(\n");
1194         }
1195         if (tmp)
1196                 ast_free(tmp);
1197         return CLI_SUCCESS;
1198 }
1199
1200 static char *console_active(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1201 {
1202         switch (cmd) {
1203         case CLI_INIT:
1204                 e->command = "console {set|show} active [<device>]";
1205                 e->usage =
1206                         "Usage: console active [device]\n"
1207                         "       If used without a parameter, displays which device is the current\n"
1208                         "       console.  If a device is specified, the console sound device is changed to\n"
1209                         "       the device specified.\n";
1210                 return NULL;
1211         case CLI_GENERATE:
1212                 return NULL;
1213         }
1214
1215         if (a->argc == 3)
1216                 ast_cli(a->fd, "active console is [%s]\n", oss_active);
1217         else if (a->argc != 4)
1218                 return CLI_SHOWUSAGE;
1219         else {
1220                 struct chan_oss_pvt *o;
1221                 if (strcmp(a->argv[3], "show") == 0) {
1222                         for (o = oss_default.next; o; o = o->next)
1223                                 ast_cli(a->fd, "device [%s] exists\n", o->name);
1224                         return CLI_SUCCESS;
1225                 }
1226                 o = find_desc(a->argv[3]);
1227                 if (o == NULL)
1228                         ast_cli(a->fd, "No device [%s] exists\n", a->argv[3]);
1229                 else
1230                         oss_active = o->name;
1231         }
1232         return CLI_SUCCESS;
1233 }
1234
1235 /*!
1236  * \brief store the boost factor
1237  */
1238 static void store_boost(struct chan_oss_pvt *o, const char *s)
1239 {
1240         double boost = 0;
1241         if (sscanf(s, "%lf", &boost) != 1) {
1242                 ast_log(LOG_WARNING, "invalid boost <%s>\n", s);
1243                 return;
1244         }
1245         if (boost < -BOOST_MAX) {
1246                 ast_log(LOG_WARNING, "boost %s too small, using %d\n", s, -BOOST_MAX);
1247                 boost = -BOOST_MAX;
1248         } else if (boost > BOOST_MAX) {
1249                 ast_log(LOG_WARNING, "boost %s too large, using %d\n", s, BOOST_MAX);
1250                 boost = BOOST_MAX;
1251         }
1252         boost = exp(log(10) * boost / 20) * BOOST_SCALE;
1253         o->boost = boost;
1254         ast_log(LOG_WARNING, "setting boost %s to %d\n", s, o->boost);
1255 }
1256
1257 static char *console_boost(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1258 {
1259         struct chan_oss_pvt *o = find_desc(oss_active);
1260
1261         switch (cmd) {
1262         case CLI_INIT:
1263                 e->command = "console boost";
1264                 e->usage =
1265                         "Usage: console boost [boost in dB]\n"
1266                         "       Sets or display mic boost in dB\n";
1267                 return NULL;
1268         case CLI_GENERATE:
1269                 return NULL;
1270         }
1271
1272         if (a->argc == 2)
1273                 ast_cli(a->fd, "boost currently %5.1f\n", 20 * log10(((double) o->boost / (double) BOOST_SCALE)));
1274         else if (a->argc == 3)
1275                 store_boost(o, a->argv[2]);
1276         return CLI_SUCCESS;
1277 }
1278
1279 static struct ast_cli_entry cli_oss[] = {
1280         AST_CLI_DEFINE(console_answer, "Answer an incoming console call"),
1281         AST_CLI_DEFINE(console_hangup, "Hangup a call on the console"),
1282         AST_CLI_DEFINE(console_flash, "Flash a call on the console"),
1283         AST_CLI_DEFINE(console_dial, "Dial an extension on the console"),
1284         AST_CLI_DEFINE(console_mute, "Disable/Enable mic input"),
1285         AST_CLI_DEFINE(console_transfer, "Transfer a call to a different extension"),   
1286         AST_CLI_DEFINE(console_cmd, "Generic console command"),
1287         AST_CLI_DEFINE(console_sendtext, "Send text to the remote device"),
1288         AST_CLI_DEFINE(console_autoanswer, "Sets/displays autoanswer"),
1289         AST_CLI_DEFINE(console_boost, "Sets/displays mic boost in dB"),
1290         AST_CLI_DEFINE(console_active, "Sets/displays active console"),
1291 };
1292
1293 /*!
1294  * store the mixer argument from the config file, filtering possibly
1295  * invalid or dangerous values (the string is used as argument for
1296  * system("mixer %s")
1297  */
1298 static void store_mixer(struct chan_oss_pvt *o, const char *s)
1299 {
1300         int i;
1301
1302         for (i = 0; i < strlen(s); i++) {
1303                 if (!isalnum(s[i]) && strchr(" \t-/", s[i]) == NULL) {
1304                         ast_log(LOG_WARNING, "Suspect char %c in mixer cmd, ignoring:\n\t%s\n", s[i], s);
1305                         return;
1306                 }
1307         }
1308         if (o->mixer_cmd)
1309                 ast_free(o->mixer_cmd);
1310         o->mixer_cmd = ast_strdup(s);
1311         ast_log(LOG_WARNING, "setting mixer %s\n", s);
1312 }
1313
1314 /*!
1315  * store the callerid components
1316  */
1317 static void store_callerid(struct chan_oss_pvt *o, const char *s)
1318 {
1319         ast_callerid_split(s, o->cid_name, sizeof(o->cid_name), o->cid_num, sizeof(o->cid_num));
1320 }
1321
1322 static void store_config_core(struct chan_oss_pvt *o, const char *var, const char *value)
1323 {
1324         CV_START(var, value);
1325
1326         /* handle jb conf */
1327         if (!ast_jb_read_conf(&global_jbconf, var, value))
1328                 return;
1329
1330         if (!console_video_config(&o->env, var, value))
1331                 return; /* matched there */
1332         CV_BOOL("autoanswer", o->autoanswer);
1333         CV_BOOL("autohangup", o->autohangup);
1334         CV_BOOL("overridecontext", o->overridecontext);
1335         CV_STR("device", o->device);
1336         CV_UINT("frags", o->frags);
1337         CV_UINT("debug", oss_debug);
1338         CV_UINT("queuesize", o->queuesize);
1339         CV_STR("context", o->ctx);
1340         CV_STR("language", o->language);
1341         CV_STR("mohinterpret", o->mohinterpret);
1342         CV_STR("extension", o->ext);
1343         CV_F("mixer", store_mixer(o, value));
1344         CV_F("callerid", store_callerid(o, value))  ;
1345         CV_F("boost", store_boost(o, value));
1346
1347         CV_END;
1348 }
1349
1350 /*!
1351  * grab fields from the config file, init the descriptor and open the device.
1352  */
1353 static struct chan_oss_pvt *store_config(struct ast_config *cfg, char *ctg)
1354 {
1355         struct ast_variable *v;
1356         struct chan_oss_pvt *o;
1357
1358         if (ctg == NULL) {
1359                 o = &oss_default;
1360                 ctg = "general";
1361         } else {
1362                 if (!(o = ast_calloc(1, sizeof(*o))))
1363                         return NULL;
1364                 *o = oss_default;
1365                 /* "general" is also the default thing */
1366                 if (strcmp(ctg, "general") == 0) {
1367                         o->name = ast_strdup("dsp");
1368                         oss_active = o->name;
1369                         goto openit;
1370                 }
1371                 o->name = ast_strdup(ctg);
1372         }
1373
1374         strcpy(o->mohinterpret, "default");
1375
1376         o->lastopen = ast_tvnow();      /* don't leave it 0 or tvdiff may wrap */
1377         /* fill other fields from configuration */
1378         for (v = ast_variable_browse(cfg, ctg); v; v = v->next) {
1379                 store_config_core(o, v->name, v->value);
1380         }
1381         if (ast_strlen_zero(o->device))
1382                 ast_copy_string(o->device, DEV_DSP, sizeof(o->device));
1383         if (o->mixer_cmd) {
1384                 char *cmd;
1385
1386                 if (asprintf(&cmd, "mixer %s", o->mixer_cmd) < 0) {
1387                         ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
1388                 } else {
1389                         ast_log(LOG_WARNING, "running [%s]\n", cmd);
1390                         if (system(cmd) < 0) {
1391                                 ast_log(LOG_WARNING, "system() failed: %s\n", strerror(errno));
1392                         }
1393                         ast_free(cmd);
1394                 }
1395         }
1396
1397         /* if the config file requested to start the GUI, do it */
1398         if (get_gui_startup(o->env))
1399                 console_video_start(o->env, NULL);
1400
1401         if (o == &oss_default)          /* we are done with the default */
1402                 return NULL;
1403
1404 openit:
1405 #ifdef TRYOPEN
1406         if (setformat(o, O_RDWR) < 0) { /* open device */
1407                 ast_verb(1, "Device %s not detected\n", ctg);
1408                 ast_verb(1, "Turn off OSS support by adding " "'noload=chan_oss.so' in /etc/asterisk/modules.conf\n");
1409                 goto error;
1410         }
1411         if (o->duplex != M_FULL)
1412                 ast_log(LOG_WARNING, "XXX I don't work right with non " "full-duplex sound cards XXX\n");
1413 #endif /* TRYOPEN */
1414
1415         /* link into list of devices */
1416         if (o != &oss_default) {
1417                 o->next = oss_default.next;
1418                 oss_default.next = o;
1419         }
1420         return o;
1421
1422 #ifdef TRYOPEN
1423 error:
1424         if (o != &oss_default)
1425                 ast_free(o);
1426         return NULL;
1427 #endif
1428 }
1429
1430 static int load_module(void)
1431 {
1432         struct ast_config *cfg = NULL;
1433         char *ctg = NULL;
1434         struct ast_flags config_flags = { 0 };
1435
1436         /* Copy the default jb config over global_jbconf */
1437         memcpy(&global_jbconf, &default_jbconf, sizeof(struct ast_jb_conf));
1438
1439         /* load config file */
1440         if (!(cfg = ast_config_load(config, config_flags))) {
1441                 ast_log(LOG_NOTICE, "Unable to load config %s\n", config);
1442                 return AST_MODULE_LOAD_DECLINE;
1443         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
1444                 ast_log(LOG_ERROR, "Config file %s is in an invalid format.  Aborting.\n", config);
1445                 return AST_MODULE_LOAD_DECLINE;
1446         }
1447
1448         do {
1449                 store_config(cfg, ctg);
1450         } while ( (ctg = ast_category_browse(cfg, ctg)) != NULL);
1451
1452         ast_config_destroy(cfg);
1453
1454         if (find_desc(oss_active) == NULL) {
1455                 ast_log(LOG_NOTICE, "Device %s not found\n", oss_active);
1456                 /* XXX we could default to 'dsp' perhaps ? */
1457                 /* XXX should cleanup allocated memory etc. */
1458                 return AST_MODULE_LOAD_FAILURE;
1459         }
1460
1461         oss_tech.capabilities |= console_video_formats;
1462
1463         if (ast_channel_register(&oss_tech)) {
1464                 ast_log(LOG_ERROR, "Unable to register channel type 'OSS'\n");
1465                 return AST_MODULE_LOAD_FAILURE;
1466         }
1467
1468         ast_cli_register_multiple(cli_oss, ARRAY_LEN(cli_oss));
1469
1470         return AST_MODULE_LOAD_SUCCESS;
1471 }
1472
1473
1474 static int unload_module(void)
1475 {
1476         struct chan_oss_pvt *o, *next;
1477
1478         ast_channel_unregister(&oss_tech);
1479         ast_cli_unregister_multiple(cli_oss, ARRAY_LEN(cli_oss));
1480
1481         o = oss_default.next;
1482         while (o) {
1483                 close(o->sounddev);
1484                 if (o->owner)
1485                         ast_softhangup(o->owner, AST_SOFTHANGUP_APPUNLOAD);
1486                 if (o->owner)                   /* XXX how ??? */
1487                         return -1;
1488                 next = o->next;
1489                 ast_free(o->name);
1490                 ast_free(o);
1491                 o = next;
1492         }
1493         return 0;
1494 }
1495
1496 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "OSS Console Channel Driver");