Add native 16kHz format for wav file format.
[asterisk/asterisk.git] / formats / format_wav.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Work with WAV in the proprietary Microsoft format.
22  * Microsoft WAV format (8000hz Signed Linear)
23  * \arg File name extension: wav (lower case)
24  * \ingroup formats
25  */
26  
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include "asterisk/mod_format.h"
32 #include "asterisk/module.h"
33 #include "asterisk/endian.h"
34
35 /* Some Ideas for this code came from makewave.c by Jeffrey Chilton */
36
37 /* Portions of the conversion code are by guido@sienanet.it */
38
39 #define WAV_BUF_SIZE    320
40
41 struct wav_desc {       /* format-specific parameters */
42         int which;
43         int bytes;
44         int lasttimeout;
45         int maxlen;
46         struct timeval last;
47 };
48
49 #define BLOCKSIZE 160
50
51 #if __BYTE_ORDER == __LITTLE_ENDIAN
52 #define htoll(b) (b)
53 #define htols(b) (b)
54 #define ltohl(b) (b)
55 #define ltohs(b) (b)
56 #else
57 #if __BYTE_ORDER == __BIG_ENDIAN
58 #define htoll(b)  \
59           (((((b)      ) & 0xFF) << 24) | \
60                ((((b) >>  8) & 0xFF) << 16) | \
61                    ((((b) >> 16) & 0xFF) <<  8) | \
62                    ((((b) >> 24) & 0xFF)      ))
63 #define htols(b) \
64           (((((b)      ) & 0xFF) << 8) | \
65                    ((((b) >> 8) & 0xFF)      ))
66 #define ltohl(b) htoll(b)
67 #define ltohs(b) htols(b)
68 #else
69 #error "Endianess not defined"
70 #endif
71 #endif
72
73
74 static int check_header(FILE *f, int which)
75 {
76         int type, size, formtype;
77         int fmt, hsize;
78         short format, chans, bysam, bisam;
79         int bysec;
80         int freq;
81         int data;
82         if (fread(&type, 1, 4, f) != 4) {
83                 ast_log(LOG_WARNING, "Read failed (type)\n");
84                 return -1;
85         }
86         if (fread(&size, 1, 4, f) != 4) {
87                 ast_log(LOG_WARNING, "Read failed (size)\n");
88                 return -1;
89         }
90         size = ltohl(size);
91         if (fread(&formtype, 1, 4, f) != 4) {
92                 ast_log(LOG_WARNING, "Read failed (formtype)\n");
93                 return -1;
94         }
95         if (memcmp(&type, "RIFF", 4)) {
96                 ast_log(LOG_WARNING, "Does not begin with RIFF\n");
97                 return -1;
98         }
99         if (memcmp(&formtype, "WAVE", 4)) {
100                 ast_log(LOG_WARNING, "Does not contain WAVE\n");
101                 return -1;
102         }
103         if (fread(&fmt, 1, 4, f) != 4) {
104                 ast_log(LOG_WARNING, "Read failed (fmt)\n");
105                 return -1;
106         }
107         if (memcmp(&fmt, "fmt ", 4)) {
108                 ast_log(LOG_WARNING, "Does not say fmt\n");
109                 return -1;
110         }
111         if (fread(&hsize, 1, 4, f) != 4) {
112                 ast_log(LOG_WARNING, "Read failed (formtype)\n");
113                 return -1;
114         }
115         if (ltohl(hsize) < 16) {
116                 ast_log(LOG_WARNING, "Unexpected header size %d\n", ltohl(hsize));
117                 return -1;
118         }
119         if (fread(&format, 1, 2, f) != 2) {
120                 ast_log(LOG_WARNING, "Read failed (format)\n");
121                 return -1;
122         }
123         if (ltohs(format) != 1) {
124                 ast_log(LOG_WARNING, "Not a wav file %d\n", ltohs(format));
125                 return -1;
126         }
127         if (fread(&chans, 1, 2, f) != 2) {
128                 ast_log(LOG_WARNING, "Read failed (format)\n");
129                 return -1;
130         }
131         if (ltohs(chans) != 1) {
132                 ast_log(LOG_WARNING, "Not in mono %d\n", ltohs(chans));
133                 return -1;
134         }
135         if (fread(&freq, 1, 4, f) != 4) {
136                 ast_log(LOG_WARNING, "Read failed (freq)\n");
137                 return -1;
138         }
139         if (ltohl(freq) != DEFAULT_SAMPLE_RATE && which == 8000) {
140                 ast_log(LOG_WARNING, "Unexpected freqency %d\n", ltohl(freq));
141                 return -1;
142         } else if (ltohl(freq) != 16000 && which == 16000) {
143                 ast_log(LOG_WARNING, "Unexpected freqency %d\n", ltohl(freq));
144                 return -1;
145         }
146         /* Ignore the byte frequency */
147         if (fread(&bysec, 1, 4, f) != 4) {
148                 ast_log(LOG_WARNING, "Read failed (BYTES_PER_SECOND)\n");
149                 return -1;
150         }
151         /* Check bytes per sample */
152         if (fread(&bysam, 1, 2, f) != 2) {
153                 ast_log(LOG_WARNING, "Read failed (BYTES_PER_SAMPLE)\n");
154                 return -1;
155         }
156         if (ltohs(bysam) != 2) {
157                 ast_log(LOG_WARNING, "Can only handle 16bits per sample: %d\n", ltohs(bysam));
158                 return -1;
159         }
160         if (fread(&bisam, 1, 2, f) != 2) {
161                 ast_log(LOG_WARNING, "Read failed (Bits Per Sample): %d\n", ltohs(bisam));
162                 return -1;
163         }
164         /* Skip any additional header */
165         if (fseek(f,ltohl(hsize)-16,SEEK_CUR) == -1 ) {
166                 ast_log(LOG_WARNING, "Failed to skip remaining header bytes: %d\n", ltohl(hsize)-16 );
167                 return -1;
168         }
169         /* Skip any facts and get the first data block */
170         for(;;)
171         { 
172                 char buf[4];
173             
174             /* Begin data chunk */
175             if (fread(&buf, 1, 4, f) != 4) {
176                         ast_log(LOG_WARNING, "Read failed (data)\n");
177                         return -1;
178             }
179             /* Data has the actual length of data in it */
180             if (fread(&data, 1, 4, f) != 4) {
181                         ast_log(LOG_WARNING, "Read failed (data)\n");
182                         return -1;
183             }
184             data = ltohl(data);
185             if(memcmp(buf, "data", 4) == 0 ) 
186                         break;
187             if(memcmp(buf, "fact", 4) != 0 ) {
188                         ast_log(LOG_WARNING, "Unknown block - not fact or data\n");
189                         return -1;
190             }
191             if (fseek(f,data,SEEK_CUR) == -1 ) {
192                         ast_log(LOG_WARNING, "Failed to skip fact block: %d\n", data );
193                         return -1;
194             }
195         }
196 #if 0
197         curpos = lseek(fd, 0, SEEK_CUR);
198         truelength = lseek(fd, 0, SEEK_END);
199         lseek(fd, curpos, SEEK_SET);
200         truelength -= curpos;
201 #endif  
202         return data;
203 }
204
205 static int update_header(FILE *f)
206 {
207         off_t cur,end;
208         int datalen,filelen,bytes;
209         
210         cur = ftello(f);
211         fseek(f, 0, SEEK_END);
212         end = ftello(f);
213         /* data starts 44 bytes in */
214         bytes = end - 44;
215         datalen = htoll(bytes);
216         /* chunk size is bytes of data plus 36 bytes of header */
217         filelen = htoll(36 + bytes);
218         
219         if (cur < 0) {
220                 ast_log(LOG_WARNING, "Unable to find our position\n");
221                 return -1;
222         }
223         if (fseek(f, 4, SEEK_SET)) {
224                 ast_log(LOG_WARNING, "Unable to set our position\n");
225                 return -1;
226         }
227         if (fwrite(&filelen, 1, 4, f) != 4) {
228                 ast_log(LOG_WARNING, "Unable to set write file size\n");
229                 return -1;
230         }
231         if (fseek(f, 40, SEEK_SET)) {
232                 ast_log(LOG_WARNING, "Unable to set our position\n");
233                 return -1;
234         }
235         if (fwrite(&datalen, 1, 4, f) != 4) {
236                 ast_log(LOG_WARNING, "Unable to set write datalen\n");
237                 return -1;
238         }
239         if (fseeko(f, cur, SEEK_SET)) {
240                 ast_log(LOG_WARNING, "Unable to return to position\n");
241                 return -1;
242         }
243         return 0;
244 }
245
246 static int write_header(FILE *f, int which)
247 {
248         unsigned int hz=htoll(8000);
249         unsigned int bhz = htoll(16000);
250         unsigned int hs = htoll(16);
251         unsigned short fmt = htols(1);
252         unsigned short chans = htols(1);
253         unsigned short bysam = htols(2);
254         unsigned short bisam = htols(16);
255         unsigned int size = htoll(0);
256         if (which == 16000) {
257                 hz = htoll(16000);
258                 bhz = htoll(32000);
259         }
260
261         /* Write a wav header, ignoring sizes which will be filled in later */
262         fseek(f,0,SEEK_SET);
263         if (fwrite("RIFF", 1, 4, f) != 4) {
264                 ast_log(LOG_WARNING, "Unable to write header\n");
265                 return -1;
266         }
267         if (fwrite(&size, 1, 4, f) != 4) {
268                 ast_log(LOG_WARNING, "Unable to write header\n");
269                 return -1;
270         }
271         if (fwrite("WAVEfmt ", 1, 8, f) != 8) {
272                 ast_log(LOG_WARNING, "Unable to write header\n");
273                 return -1;
274         }
275         if (fwrite(&hs, 1, 4, f) != 4) {
276                 ast_log(LOG_WARNING, "Unable to write header\n");
277                 return -1;
278         }
279         if (fwrite(&fmt, 1, 2, f) != 2) {
280                 ast_log(LOG_WARNING, "Unable to write header\n");
281                 return -1;
282         }
283         if (fwrite(&chans, 1, 2, f) != 2) {
284                 ast_log(LOG_WARNING, "Unable to write header\n");
285                 return -1;
286         }
287         if (fwrite(&hz, 1, 4, f) != 4) {
288                 ast_log(LOG_WARNING, "Unable to write header\n");
289                 return -1;
290         }
291         if (fwrite(&bhz, 1, 4, f) != 4) {
292                 ast_log(LOG_WARNING, "Unable to write header\n");
293                 return -1;
294         }
295         if (fwrite(&bysam, 1, 2, f) != 2) {
296                 ast_log(LOG_WARNING, "Unable to write header\n");
297                 return -1;
298         }
299         if (fwrite(&bisam, 1, 2, f) != 2) {
300                 ast_log(LOG_WARNING, "Unable to write header\n");
301                 return -1;
302         }
303         if (fwrite("data", 1, 4, f) != 4) {
304                 ast_log(LOG_WARNING, "Unable to write header\n");
305                 return -1;
306         }
307         if (fwrite(&size, 1, 4, f) != 4) {
308                 ast_log(LOG_WARNING, "Unable to write header\n");
309                 return -1;
310         }
311         return 0;
312 }
313
314 static int wav_open(struct ast_filestream *s)
315 {
316         /* We don't have any header to read or anything really, but
317            if we did, it would go here.  We also might want to check
318            and be sure it's a valid file.  */
319         struct wav_desc *tmp = (struct wav_desc *)s->_private;
320         if ((tmp->maxlen = check_header(s->f, tmp->which)) < 0)
321                 return -1;
322         return 0;
323 }
324
325 static int wav16_open(struct ast_filestream *s)
326 {
327         struct wav_desc *tmp = (struct wav_desc *)s->_private;
328         tmp->which = 16000;
329         return wav_open(s);
330 }
331
332 static int wav_rewrite(struct ast_filestream *s, const char *comment)
333 {
334         /* We don't have any header to read or anything really, but
335            if we did, it would go here.  We also might want to check
336            and be sure it's a valid file.  */
337         struct wav_desc *tmp = (struct wav_desc *)s->_private;
338
339         if (write_header(s->f, tmp->which))
340                 return -1;
341         return 0;
342 }
343
344 static int wav16_rewrite(struct ast_filestream *s, const char *comment)
345 {
346         struct wav_desc *tmp = (struct wav_desc *)s->_private;
347         tmp->which = 16000;
348         return wav_rewrite(s, comment);
349 }
350
351 static void wav_close(struct ast_filestream *s)
352 {
353         char zero = 0;
354         struct wav_desc *fs = (struct wav_desc *)s->_private;
355
356         if (s->filename) {
357                 update_header(s->f);
358         }
359
360         /* Pad to even length */
361         if (fs->bytes & 0x1)
362                 fwrite(&zero, 1, 1, s->f);
363 }
364
365 static struct ast_frame *wav_read(struct ast_filestream *s, int *whennext)
366 {
367         int res;
368         int samples;    /* actual samples read */
369 #if __BYTE_ORDER == __BIG_ENDIAN
370         int x;
371 #endif
372         short *tmp;
373         int bytes = WAV_BUF_SIZE;       /* in bytes */
374         off_t here;
375         /* Send a frame from the file to the appropriate channel */
376         struct wav_desc *fs = (struct wav_desc *)s->_private;
377
378         if (fs->which == 16000) {
379                 bytes *= 2;
380         }
381
382         here = ftello(s->f);
383         if (fs->maxlen - here < bytes)          /* truncate if necessary */
384                 bytes = fs->maxlen - here;
385         if (bytes < 0)
386                 bytes = 0;
387 /*      ast_debug(1, "here: %d, maxlen: %d, bytes: %d\n", here, s->maxlen, bytes); */
388         s->fr.frametype = AST_FRAME_VOICE;
389         s->fr.subclass = fs->which == 16000 ? AST_FORMAT_SLINEAR16 : AST_FORMAT_SLINEAR;
390         s->fr.mallocd = 0;
391         AST_FRAME_SET_BUFFER(&s->fr, s->buf, AST_FRIENDLY_OFFSET, bytes);
392
393         if ( (res = fread(s->fr.data.ptr, 1, s->fr.datalen, s->f)) <= 0 ) {
394                 if (res)
395                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
396                 return NULL;
397         }
398         s->fr.datalen = res;
399         s->fr.samples = samples = res / 2;
400
401         tmp = (short *)(s->fr.data.ptr);
402 #if __BYTE_ORDER == __BIG_ENDIAN
403         /* file format is little endian so we need to swap */
404         for( x = 0; x < samples * (fs->which == 16000 ? 2 : 1); x++)
405                 tmp[x] = (tmp[x] << 8) | ((tmp[x] & 0xff00) >> 8);
406 #endif
407
408         *whennext = samples;
409         return &s->fr;
410 }
411
412 static int wav_write(struct ast_filestream *fs, struct ast_frame *f)
413 {
414 #if __BYTE_ORDER == __BIG_ENDIAN
415         int x;
416         short tmp[16000], *tmpi;
417 #endif
418         struct wav_desc *s = (struct wav_desc *)fs->_private;
419         int res;
420
421         if (f->frametype != AST_FRAME_VOICE) {
422                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
423                 return -1;
424         }
425         if (f->subclass != AST_FORMAT_SLINEAR && s->which == 0) {
426                 ast_log(LOG_WARNING, "Asked to write non-SLINEAR frame (%d)!\n", f->subclass);
427                 return -1;
428         } else if (f->subclass != AST_FORMAT_SLINEAR16 && s->which == 16000) {
429                 ast_log(LOG_WARNING, "Asked to write non-SLINEAR16 frame (%d)!\n", f->subclass);
430                 return -1;
431         }
432         if (!f->datalen)
433                 return -1;
434
435 #if __BYTE_ORDER == __BIG_ENDIAN
436         /* swap and write */
437         if (f->datalen > sizeof(tmp)) {
438                 ast_log(LOG_WARNING, "Data length is too long\n");
439                 return -1;
440         }
441         tmpi = f->data.ptr;
442         for (x=0; x < f->datalen/2; x++) 
443                 tmp[x] = (tmpi[x] << 8) | ((tmpi[x] & 0xff00) >> 8);
444
445         if ((res = fwrite(tmp, 1, f->datalen, fs->f)) != f->datalen ) {
446 #else
447         /* just write */
448         if ((res = fwrite(f->data.ptr, 1, f->datalen, fs->f)) != f->datalen ) {
449 #endif
450                 ast_log(LOG_WARNING, "Bad write (%d): %s\n", res, strerror(errno));
451                 return -1;
452         }
453
454         s->bytes += f->datalen;
455
456         return 0;
457 }
458
459 static int wav16_write(struct ast_filestream *fs, struct ast_frame *f)
460 {
461         struct wav_desc *s = (struct wav_desc *)fs->_private;
462         s->which = 16000;
463         return wav_write(fs, f);
464 }
465
466 static int wav_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
467 {
468         off_t min, max, cur, offset = 0, samples;
469
470         samples = sample_offset * 2; /* SLINEAR is 16 bits mono, so sample_offset * 2 = bytes */
471         min = 44; /* wav header is 44 bytes */
472         cur = ftello(fs->f);
473         fseeko(fs->f, 0, SEEK_END);
474         max = ftello(fs->f);
475         if (whence == SEEK_SET)
476                 offset = samples + min;
477         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
478                 offset = samples + cur;
479         else if (whence == SEEK_END)
480                 offset = max - samples;
481         if (whence != SEEK_FORCECUR) {
482                 offset = (offset > max)?max:offset;
483         }
484         /* always protect the header space. */
485         offset = (offset < min)?min:offset;
486         return fseeko(fs->f, offset, SEEK_SET);
487 }
488
489 static int wav_trunc(struct ast_filestream *fs)
490 {
491         if (ftruncate(fileno(fs->f), ftello(fs->f)))
492                 return -1;
493         return update_header(fs->f);
494 }
495
496 static off_t wav_tell(struct ast_filestream *fs)
497 {
498         off_t offset;
499         offset = ftello(fs->f);
500         /* subtract header size to get samples, then divide by 2 for 16 bit samples */
501         return (offset - 44)/2;
502 }
503
504 static const struct ast_format wav_f = {
505         .name = "wav",
506         .exts = "wav",
507         .format = AST_FORMAT_SLINEAR,
508         .open = wav_open,
509         .rewrite = wav_rewrite,
510         .write = wav_write,
511         .seek = wav_seek,
512         .trunc = wav_trunc,
513         .tell = wav_tell,
514         .read = wav_read,
515         .close = wav_close,
516         .buf_size = WAV_BUF_SIZE + AST_FRIENDLY_OFFSET,
517         .desc_size = sizeof(struct wav_desc),
518 };
519
520 static const struct ast_format Wav_f = {
521         .name = "wav16",
522         .exts = "Wav|wav16",
523         .format = AST_FORMAT_SLINEAR16,
524         .open = wav16_open,
525         .rewrite = wav16_rewrite,
526         .write = wav16_write,
527         .seek = wav_seek,
528         .trunc = wav_trunc,
529         .tell = wav_tell,
530         .read = wav_read,
531         .close = wav_close,
532         .buf_size = WAV_BUF_SIZE * 2 + AST_FRIENDLY_OFFSET,
533         .desc_size = sizeof(struct wav_desc),
534 };
535
536 static int load_module(void)
537 {
538         if (ast_format_register(&wav_f))
539                 return AST_MODULE_LOAD_FAILURE;
540         ast_format_register(&Wav_f);
541         return AST_MODULE_LOAD_SUCCESS;
542 }
543
544 static int unload_module(void)
545 {
546         int res;
547         if (!(res = ast_format_unregister(Wav_f.name))) {
548                 return ast_format_unregister(wav_f.name);
549         } else {
550                 return res;
551         }
552 }       
553
554 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Microsoft WAV format (8000Hz Signed Linear)");