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