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