Version 0.1.8 from FTP
[asterisk/asterisk.git] / formats / format_vox.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Flat, binary, ADPCM vox file format.
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13  
14 #include <asterisk/channel.h>
15 #include <asterisk/file.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/sched.h>
18 #include <asterisk/module.h>
19 #include <arpa/inet.h>
20 #include <stdlib.h>
21 #include <sys/time.h>
22 #include <stdio.h>
23 #include <unistd.h>
24 #include <errno.h>
25 #include <string.h>
26 #include <pthread.h>
27 #include <endian.h>
28
29 #define BUF_SIZE 80             /* 160 samples */
30
31 struct ast_filestream {
32         void *reserved[AST_RESERVED_POINTERS];
33         /* Believe it or not, we must decode/recode to account for the
34            weird MS format */
35         /* This is what a filestream means to us */
36         int fd; /* Descriptor */
37         struct ast_channel *owner;
38         struct ast_frame fr;                            /* Frame information */
39         char waste[AST_FRIENDLY_OFFSET];        /* Buffer for sending frames, etc */
40         char empty;                                                     /* Empty character */
41         unsigned char buf[BUF_SIZE + 3];                                /* Output Buffer */
42         int lasttimeout;
43         struct timeval last;
44         int adj;
45         short signal;                                           /* Signal level (file side) */
46         short ssindex;                                          /* Signal ssindex (file side) */
47         struct ast_filestream *next;
48 };
49
50
51 static struct ast_filestream *glist = NULL;
52 static pthread_mutex_t vox_lock = PTHREAD_MUTEX_INITIALIZER;
53 static int glistcnt = 0;
54
55 static char *name = "vox";
56 static char *desc = "Dialogic VOX (ADPCM) File Format";
57 static char *exts = "vox";
58
59 /*
60  * Step size index shift table 
61  */
62
63 static short indsft[8] = { -1, -1, -1, -1, 2, 4, 6, 8 };
64
65 /*
66  * Step size table, where stpsz[i]=floor[16*(11/10)^i]
67  */
68
69 static short stpsz[49] = {
70   16, 17, 19, 21, 23, 25, 28, 31, 34, 37, 41, 45, 50, 55, 60, 66, 73,
71   80, 88, 97, 107, 118, 130, 143, 157, 173, 190, 209, 230, 253, 279,
72   307, 337, 371, 408, 449, 494, 544, 598, 658, 724, 796, 876, 963,
73   1060, 1166, 1282, 1411, 1552
74 };
75
76 /* 
77  * Nibble to bit map
78  */
79
80 static short nbl2bit[16][4] = {
81   {1, 0, 0, 0}, {1, 0, 0, 1}, {1, 0, 1, 0}, {1, 0, 1, 1},
82   {1, 1, 0, 0}, {1, 1, 0, 1}, {1, 1, 1, 0}, {1, 1, 1, 1},
83   {-1, 0, 0, 0}, {-1, 0, 0, 1}, {-1, 0, 1, 0}, {-1, 0, 1, 1},
84   {-1, 1, 0, 0}, {-1, 1, 0, 1}, {-1, 1, 1, 0}, {-1, 1, 1, 1}
85 };
86
87 /*
88  * Decode(encoded)
89  *  Decodes the encoded nibble from the adpcm file.
90  *
91  * Results:
92  *  Returns the encoded difference.
93  *
94  * Side effects:
95  *  Sets the index to the step size table for the next encode.
96  */
97
98 static inline short
99 decode (unsigned char encoded, short *ssindex)
100 {
101   short diff, step;
102   step = stpsz[*ssindex];
103   diff = nbl2bit[encoded][0] * (step * nbl2bit[encoded][1] +
104                                 (step >> 1) * nbl2bit[encoded][2] +
105                                 (step >> 2) * nbl2bit[encoded][3] +
106                                 (step >> 3));
107   *ssindex = *ssindex + indsft[(encoded & 7)];
108   if (*ssindex < 0)
109     *ssindex = 0;
110   else if (*ssindex > 48)
111     *ssindex = 48;
112   return (diff);
113 }
114
115 /*
116  * Adpcm
117  *  Takes a signed linear signal and encodes it as ADPCM
118  *  For more information see http://support.dialogic.com/appnotes/adpcm.pdf
119  *
120  * Results:
121  *  Foo.
122  *
123  * Side effects:
124  *  signal gets updated with each pass.
125  */
126
127 static inline unsigned char
128 adpcm (short csig, short *ssindex, short *signal)
129 {
130   short diff, step;
131   unsigned char encoded;
132   step = stpsz[*ssindex];
133   /* 
134    * Clip csig if too large or too small
135    */
136    
137   csig >>= 4;
138
139   diff = csig - *signal;
140   
141   if (diff < 0)
142     {
143       encoded = 8;
144       diff = -diff;
145     }
146   else
147     encoded = 0;
148   if (diff >= step)
149     {
150       encoded |= 4;
151       diff -= step;
152     }
153   step >>= 1;
154   if (diff >= step)
155     {
156       encoded |= 2;
157       diff -= step;
158     }
159   step >>= 1;
160   if (diff >= step)
161     encoded |= 1;
162     
163   *signal += decode (encoded, ssindex);
164   return (encoded);
165 }
166
167 static struct ast_filestream *vox_open(int fd)
168 {
169         /* We don't have any header to read or anything really, but
170            if we did, it would go here.  We also might want to check
171            and be sure it's a valid file.  */
172         struct ast_filestream *tmp;
173         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
174                 memset(tmp, 0, sizeof(struct ast_filestream));
175                 if (ast_pthread_mutex_lock(&vox_lock)) {
176                         ast_log(LOG_WARNING, "Unable to lock vox list\n");
177                         free(tmp);
178                         return NULL;
179                 }
180                 tmp->next = glist;
181                 glist = tmp;
182                 tmp->fd = fd;
183                 tmp->owner = NULL;
184                 tmp->fr.data = tmp->buf;
185                 tmp->fr.frametype = AST_FRAME_VOICE;
186                 tmp->fr.subclass = AST_FORMAT_ADPCM;
187                 /* datalen will vary for each frame */
188                 tmp->fr.src = name;
189                 tmp->fr.mallocd = 0;
190                 tmp->lasttimeout = -1;
191                 glistcnt++;
192                 ast_pthread_mutex_unlock(&vox_lock);
193                 ast_update_use_count();
194         }
195         return tmp;
196 }
197
198 static struct ast_filestream *vox_rewrite(int fd, char *comment)
199 {
200         /* We don't have any header to read or anything really, but
201            if we did, it would go here.  We also might want to check
202            and be sure it's a valid file.  */
203         struct ast_filestream *tmp;
204         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
205                 memset(tmp, 0, sizeof(struct ast_filestream));
206                 if (ast_pthread_mutex_lock(&vox_lock)) {
207                         ast_log(LOG_WARNING, "Unable to lock vox list\n");
208                         free(tmp);
209                         return NULL;
210                 }
211                 tmp->next = glist;
212                 glist = tmp;
213                 tmp->fd = fd;
214                 tmp->owner = NULL;
215                 tmp->lasttimeout = -1;
216                 glistcnt++;
217                 ast_pthread_mutex_unlock(&vox_lock);
218                 ast_update_use_count();
219         } else
220                 ast_log(LOG_WARNING, "Out of memory\n");
221         return tmp;
222 }
223
224 static struct ast_frame *vox_read(struct ast_filestream *s)
225 {
226         return NULL;
227 }
228
229 static void vox_close(struct ast_filestream *s)
230 {
231         struct ast_filestream *tmp, *tmpl = NULL;
232         if (ast_pthread_mutex_lock(&vox_lock)) {
233                 ast_log(LOG_WARNING, "Unable to lock vox list\n");
234                 return;
235         }
236         tmp = glist;
237         while(tmp) {
238                 if (tmp == s) {
239                         if (tmpl)
240                                 tmpl->next = tmp->next;
241                         else
242                                 glist = tmp->next;
243                         break;
244                 }
245                 tmpl = tmp;
246                 tmp = tmp->next;
247         }
248         glistcnt--;
249         if (s->owner) {
250                 s->owner->stream = NULL;
251                 if (s->owner->streamid > -1)
252                         ast_sched_del(s->owner->sched, s->owner->streamid);
253                 s->owner->streamid = -1;
254         }
255         ast_pthread_mutex_unlock(&vox_lock);
256         ast_update_use_count();
257         if (!tmp) 
258                 ast_log(LOG_WARNING, "Freeing a filestream we don't seem to own\n");
259         close(s->fd);
260         free(s);
261 }
262
263 static int ast_read_callback(void *data)
264 {
265         int retval = 0;
266         int res;
267         int delay;
268         struct ast_filestream *s = data;
269         struct timeval tv;
270         int x;
271         /* Send a frame from the file to the appropriate channel */
272
273         s->fr.frametype = AST_FRAME_VOICE;
274         s->fr.subclass = AST_FORMAT_ADPCM;
275         s->fr.offset = AST_FRIENDLY_OFFSET;
276         s->fr.mallocd = 0;
277         s->fr.data = s->buf;
278         if ((res = read(s->fd, s->buf + 3, BUF_SIZE)) < 1) {
279                 if (res)
280                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
281                 s->owner->streamid = -1;
282                 return 0;
283         }
284         /* Store index, then signal */
285         s->buf[0] = s->ssindex & 0xff;
286         s->buf[1] = (s->signal >> 8) & 0xff;
287         s->buf[2] = s->signal & 0xff;
288         /* Do the decoder to be sure we get the right stuff in the signal and index fields. */
289         for (x=3;x<res+3;x++) {
290                 s->signal += decode(s->buf[x] >> 4, &s->ssindex);
291                 s->signal += decode(s->buf[x] & 0xf, &s->ssindex);
292         }
293         s->fr.timelen = res / 4;
294         s->fr.datalen = res + 3;
295         delay = s->fr.timelen;
296         /* Lastly, process the frame */
297         if (ast_write(s->owner, &s->fr)) {
298                 ast_log(LOG_WARNING, "Failed to write frame\n");
299                 s->owner->streamid = -1;
300                 return 0;
301         }
302         if (s->last.tv_usec || s->last.tv_usec) {
303                 int ms;
304                 gettimeofday(&tv, NULL);
305                 ms = 1000 * (tv.tv_sec - s->last.tv_sec) + 
306                         (tv.tv_usec - s->last.tv_usec) / 1000;
307                 s->last.tv_sec = tv.tv_sec;
308                 s->last.tv_usec = tv.tv_usec;
309                 if ((ms - delay) * (ms - delay) > 4) {
310                         /* Compensate if we're more than 2 ms off */
311                         s->adj -= (ms - delay);
312                 }
313 #if 0
314                 fprintf(stdout, "Delay is %d, adjustment is %d, last was %d\n", delay, s->adj, ms);
315 #endif
316                 delay += s->adj;
317                 if (delay < 1)
318                         delay = 1;
319         } else
320                 gettimeofday(&s->last, NULL);
321         if (s->lasttimeout != delay) {
322                 /* We'll install the next timeout now. */
323                 s->owner->streamid = ast_sched_add(s->owner->sched,
324                                 delay, ast_read_callback, s); 
325                 s->lasttimeout = delay;
326         } else {
327                 /* Just come back again at the same time */
328                 retval = -1;
329         }
330         return retval;
331 }
332
333 static int vox_apply(struct ast_channel *c, struct ast_filestream *s)
334 {
335         /* Select our owner for this stream, and get the ball rolling. */
336         s->owner = c;
337         ast_read_callback(s);
338         return 0;
339 }
340
341 static int vox_write(struct ast_filestream *fs, struct ast_frame *f)
342 {
343         int res;
344         if (f->frametype != AST_FRAME_VOICE) {
345                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
346                 return -1;
347         }
348         if (f->subclass != AST_FORMAT_ADPCM) {
349                 ast_log(LOG_WARNING, "Asked to write non-ADPCM frame (%d)!\n", f->subclass);
350                 return -1;
351         }
352         if (f->datalen < 3) {
353                 ast_log(LOG_WARNING, "Invalid frame of data (< 3 bytes long) from %s\n", f->src);
354                 return -1;
355         }
356         if ((res = write(fs->fd, f->data + 3, f->datalen)) != f->datalen) {
357                         ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
358                         return -1;
359         }
360         return 0;
361 }
362
363 static char *vox_getcomment(struct ast_filestream *s)
364 {
365         return NULL;
366 }
367
368 int load_module()
369 {
370         return ast_format_register(name, exts, AST_FORMAT_ADPCM,
371                                                                 vox_open,
372                                                                 vox_rewrite,
373                                                                 vox_apply,
374                                                                 vox_write,
375                                                                 vox_read,
376                                                                 vox_close,
377                                                                 vox_getcomment);
378                                                                 
379                                                                 
380 }
381
382 int unload_module()
383 {
384         struct ast_filestream *tmp, *tmpl;
385         if (ast_pthread_mutex_lock(&vox_lock)) {
386                 ast_log(LOG_WARNING, "Unable to lock vox list\n");
387                 return -1;
388         }
389         tmp = glist;
390         while(tmp) {
391                 if (tmp->owner)
392                         ast_softhangup(tmp->owner);
393                 tmpl = tmp;
394                 tmp = tmp->next;
395                 free(tmpl);
396         }
397         ast_pthread_mutex_unlock(&vox_lock);
398         return ast_format_unregister(name);
399 }       
400
401 int usecount()
402 {
403         int res;
404         if (ast_pthread_mutex_lock(&vox_lock)) {
405                 ast_log(LOG_WARNING, "Unable to lock vox list\n");
406                 return -1;
407         }
408         res = glistcnt;
409         ast_pthread_mutex_unlock(&vox_lock);
410         return res;
411 }
412
413 char *description()
414 {
415         return desc;
416 }
417
418
419 char *key()
420 {
421         return ASTERISK_GPL_KEY;
422 }