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