Minor ADPCM quality enhancements
[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/lock.h>
15 #include <asterisk/channel.h>
16 #include <asterisk/file.h>
17 #include <asterisk/logger.h>
18 #include <asterisk/sched.h>
19 #include <asterisk/module.h>
20 #include <netinet/in.h>
21 #include <arpa/inet.h>
22 #include <stdlib.h>
23 #include <sys/time.h>
24 #include <stdio.h>
25 #include <unistd.h>
26 #include <errno.h>
27 #include <string.h>
28 #include <pthread.h>
29 #ifdef __linux__
30 #include <endian.h>
31 #else
32 #include <machine/endian.h>
33 #endif
34
35 #define BUF_SIZE 80             /* 160 samples */
36 #define BUF_SHIFT       5
37
38 struct ast_filestream {
39         void *reserved[AST_RESERVED_POINTERS];
40         /* This is what a filestream means to us */
41         int fd; /* Descriptor */
42         struct ast_frame fr;                            /* Frame information */
43         char waste[AST_FRIENDLY_OFFSET];        /* Buffer for sending frames, etc */
44         char empty;                                                     /* Empty character */
45         unsigned char buf[BUF_SIZE + BUF_SHIFT];        /* Output Buffer */
46         int lasttimeout;
47         struct timeval last;
48         short signal;                                           /* Signal level (file side) */
49         short ssindex;                                          /* Signal ssindex (file side) */
50         unsigned char zero_count;                               /* counter of consecutive zero samples */
51         unsigned char next_flag;
52 };
53
54
55 static ast_mutex_t vox_lock = AST_MUTEX_INITIALIZER;
56 static int glistcnt = 0;
57
58 static char *name = "vox";
59 static char *desc = "Dialogic VOX (ADPCM) File Format";
60 static char *exts = "vox";
61
62 /*
63  * Step size index shift table 
64  */
65
66 static short indsft[8] = { -1, -1, -1, -1, 2, 4, 6, 8 };
67
68 /*
69  * Step size table, where stpsz[i]=floor[16*(11/10)^i]
70  */
71
72 static short stpsz[49] = {
73   16, 17, 19, 21, 23, 25, 28, 31, 34, 37, 41, 45, 50, 55, 60, 66, 73,
74   80, 88, 97, 107, 118, 130, 143, 157, 173, 190, 209, 230, 253, 279,
75   307, 337, 371, 408, 449, 494, 544, 598, 658, 724, 796, 876, 963,
76   1060, 1166, 1282, 1411, 1552
77 };
78
79 /* 
80  * Nibble to bit map
81  */
82
83 static short nbl2bit[16][4] = {
84   {1, 0, 0, 0}, {1, 0, 0, 1}, {1, 0, 1, 0}, {1, 0, 1, 1},
85   {1, 1, 0, 0}, {1, 1, 0, 1}, {1, 1, 1, 0}, {1, 1, 1, 1},
86   {-1, 0, 0, 0}, {-1, 0, 0, 1}, {-1, 0, 1, 0}, {-1, 0, 1, 1},
87   {-1, 1, 0, 0}, {-1, 1, 0, 1}, {-1, 1, 1, 0}, {-1, 1, 1, 1}
88 };
89
90 /*
91  * Decode(encoded)
92  *  Decodes the encoded nibble from the adpcm file.
93  *
94  * Results:
95  *  Returns the encoded difference.
96  *
97  * Side effects:
98  *  Sets the index to the step size table for the next encode.
99  */
100
101 static inline void 
102 decode (unsigned char encoded, short *ssindex, short *signal, unsigned char *rkey, unsigned char *next)
103 {
104   short diff, step;
105   step = stpsz[*ssindex];
106
107   diff = step * nbl2bit[encoded][1] +
108                 (step >> 1) * nbl2bit[encoded][2] +
109                 (step >> 2) * nbl2bit[encoded][3] +
110                 (step >> 3);
111   if (nbl2bit[encoded][2] && (step & 0x1))
112         diff++;
113   diff *= nbl2bit[encoded][0];
114
115   if ( *next & 0x1 )
116         *signal -= 8;
117   else if ( *next & 0x2 )
118         *signal += 8;
119
120   *signal += diff;
121
122   if (*signal > 2047)
123         *signal = 2047;
124   else if (*signal < -2047)
125         *signal = -2047;
126
127   *next = 0;
128   if( encoded & 0x7 )
129         *rkey = 0;
130   else if ( ++(*rkey) == 24 ) {
131         *rkey = 0;
132         if (*signal > 0)
133                 *next = 0x1;
134         else if (*signal < 0)
135                 *next = 0x2;
136   }
137
138   *ssindex = *ssindex + indsft[(encoded & 7)];
139   if (*ssindex < 0)
140     *ssindex = 0;
141   else if (*ssindex > 48)
142     *ssindex = 48;
143 }
144
145 /*
146  * Adpcm
147  *  Takes a signed linear signal and encodes it as ADPCM
148  *  For more information see http://support.dialogic.com/appnotes/adpcm.pdf
149  *
150  * Results:
151  *  Foo.
152  *
153  * Side effects:
154  *  signal gets updated with each pass.
155  */
156
157 static inline unsigned char
158 adpcm (short csig, short *ssindex, short *signal)
159 {
160   short diff, step;
161   unsigned char encoded;
162   unsigned char zero_count, next_flag;
163   step = stpsz[*ssindex];
164   /* 
165    * Clip csig if too large or too small
166    */
167    
168   csig >>= 4;
169
170   diff = csig - *signal;
171   
172   if (diff < 0)
173     {
174       encoded = 8;
175       diff = -diff;
176     }
177   else
178     encoded = 0;
179   if (diff >= step)
180     {
181       encoded |= 4;
182       diff -= step;
183     }
184   step >>= 1;
185   if (diff >= step)
186     {
187       encoded |= 2;
188       diff -= step;
189     }
190   step >>= 1;
191   if (diff >= step)
192     encoded |= 1;
193     
194   decode (encoded, ssindex, signal, &zero_count, &next_flag);
195
196   return (encoded);
197 }
198
199 static struct ast_filestream *vox_open(int fd)
200 {
201         /* We don't have any header to read or anything really, but
202            if we did, it would go here.  We also might want to check
203            and be sure it's a valid file.  */
204         struct ast_filestream *tmp;
205         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
206                 memset(tmp, 0, sizeof(struct ast_filestream));
207                 if (ast_mutex_lock(&vox_lock)) {
208                         ast_log(LOG_WARNING, "Unable to lock vox list\n");
209                         free(tmp);
210                         return NULL;
211                 }
212                 tmp->fd = fd;
213                 tmp->fr.data = tmp->buf;
214                 tmp->fr.frametype = AST_FRAME_VOICE;
215                 tmp->fr.subclass = AST_FORMAT_ADPCM;
216                 /* datalen will vary for each frame */
217                 tmp->fr.src = name;
218                 tmp->fr.mallocd = 0;
219                 tmp->lasttimeout = -1;
220                 glistcnt++;
221                 ast_mutex_unlock(&vox_lock);
222                 ast_update_use_count();
223         }
224         return tmp;
225 }
226
227 static struct ast_filestream *vox_rewrite(int fd, char *comment)
228 {
229         /* We don't have any header to read or anything really, but
230            if we did, it would go here.  We also might want to check
231            and be sure it's a valid file.  */
232         struct ast_filestream *tmp;
233         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
234                 memset(tmp, 0, sizeof(struct ast_filestream));
235                 if (ast_mutex_lock(&vox_lock)) {
236                         ast_log(LOG_WARNING, "Unable to lock vox list\n");
237                         free(tmp);
238                         return NULL;
239                 }
240                 tmp->fd = fd;
241                 glistcnt++;
242                 ast_mutex_unlock(&vox_lock);
243                 ast_update_use_count();
244         } else
245                 ast_log(LOG_WARNING, "Out of memory\n");
246         return tmp;
247 }
248
249 static void vox_close(struct ast_filestream *s)
250 {
251         if (ast_mutex_lock(&vox_lock)) {
252                 ast_log(LOG_WARNING, "Unable to lock vox list\n");
253                 return;
254         }
255         glistcnt--;
256         ast_mutex_unlock(&vox_lock);
257         ast_update_use_count();
258         close(s->fd);
259         free(s);
260         s = NULL;
261 }
262
263 static struct ast_frame *vox_read(struct ast_filestream *s, int *whennext)
264 {
265         int res;
266         int x;
267         /* Send a frame from the file to the appropriate channel */
268         s->fr.frametype = AST_FRAME_VOICE;
269         s->fr.subclass = AST_FORMAT_ADPCM;
270         s->fr.offset = AST_FRIENDLY_OFFSET;
271         s->fr.mallocd = 0;
272         s->fr.data = s->buf;
273         if ((res = read(s->fd, s->buf + BUF_SHIFT, BUF_SIZE)) < 1) {
274                 if (res)
275                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
276                 return NULL;
277         }
278         /* Store index, then signal */
279         s->buf[0] = s->ssindex & 0xff;
280         s->buf[1] = (s->signal >> 8) & 0xff;
281         s->buf[2] = s->signal & 0xff;
282         s->buf[3] = s->zero_count;
283         s->buf[4] = s->next_flag;
284         /* Do the decoder to be sure we get the right stuff in the signal and index fields. */
285         for (x=BUF_SHIFT;x<res+BUF_SHIFT;x++) {
286                 decode (s->buf[x] >> 4, &s->ssindex, &s->signal, &s->zero_count, &s->next_flag);
287                 decode (s->buf[x] & 0xf, &s->ssindex, &s->signal, &s->zero_count, &s->next_flag);
288         }
289         s->fr.samples = res * 2;
290         s->fr.datalen = res + BUF_SHIFT;
291         *whennext = s->fr.samples;
292         return &s->fr;
293 }
294
295 static int vox_write(struct ast_filestream *fs, struct ast_frame *f)
296 {
297         int res;
298         if (f->frametype != AST_FRAME_VOICE) {
299                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
300                 return -1;
301         }
302         if (f->subclass != AST_FORMAT_ADPCM) {
303                 ast_log(LOG_WARNING, "Asked to write non-ADPCM frame (%d)!\n", f->subclass);
304                 return -1;
305         }
306         if (f->datalen < BUF_SHIFT) {
307                 ast_log(LOG_WARNING, "Invalid frame of data (< %d bytes long) from %s\n", BUF_SHIFT, f->src);
308                 return -1;
309         }
310         if ((res = write(fs->fd, f->data + BUF_SHIFT, f->datalen - BUF_SHIFT)) != f->datalen - BUF_SHIFT) {
311                         ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
312                         return -1;
313         }
314         return 0;
315 }
316
317 static char *vox_getcomment(struct ast_filestream *s)
318 {
319         return NULL;
320 }
321
322 static int vox_seek(struct ast_filestream *fs, long sample_offset, int whence)
323 {
324         return -1;
325 }
326
327 static int vox_trunc(struct ast_filestream *fs)
328 {
329         return -1;
330 }
331
332 static long vox_tell(struct ast_filestream *fs)
333 {
334         return -1;
335 }
336
337 int load_module()
338 {
339         return ast_format_register(name, exts, AST_FORMAT_ADPCM,
340                                                                 vox_open,
341                                                                 vox_rewrite,
342                                                                 vox_write,
343                                                                 vox_seek,
344                                                                 vox_trunc,
345                                                                 vox_tell,
346                                                                 vox_read,
347                                                                 vox_close,
348                                                                 vox_getcomment);
349                                                                 
350                                                                 
351 }
352
353 int unload_module()
354 {
355         return ast_format_unregister(name);
356 }       
357
358 int usecount()
359 {
360         int res;
361         if (ast_mutex_lock(&vox_lock)) {
362                 ast_log(LOG_WARNING, "Unable to lock vox list\n");
363                 return -1;
364         }
365         res = glistcnt;
366         ast_mutex_unlock(&vox_lock);
367         return res;
368 }
369
370 char *description()
371 {
372         return desc;
373 }
374
375
376 char *key()
377 {
378         return ASTERISK_GPL_KEY;
379 }