17a4af054ba59337d63755f77c52b5f6c7e5d4b0
[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 /*** MODULEINFO
28         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/mod_format.h"
36 #include "asterisk/module.h"
37 #include "asterisk/endian.h"
38
39 /* Some Ideas for this code came from makewave.c by Jeffrey Chilton */
40
41 /* Portions of the conversion code are by guido@sienanet.it */
42
43 #define WAV_BUF_SIZE    320
44
45 struct wav_desc {       /* format-specific parameters */
46         int hz;
47         int bytes;
48         int lasttimeout;
49         int maxlen;
50         struct timeval last;
51 };
52
53 #define BLOCKSIZE 160
54
55 #if __BYTE_ORDER == __LITTLE_ENDIAN
56 #define htoll(b) (b)
57 #define htols(b) (b)
58 #define ltohl(b) (b)
59 #define ltohs(b) (b)
60 #else
61 #if __BYTE_ORDER == __BIG_ENDIAN
62 #define htoll(b)  \
63           (((((b)      ) & 0xFF) << 24) | \
64                ((((b) >>  8) & 0xFF) << 16) | \
65                    ((((b) >> 16) & 0xFF) <<  8) | \
66                    ((((b) >> 24) & 0xFF)      ))
67 #define htols(b) \
68           (((((b)      ) & 0xFF) << 8) | \
69                    ((((b) >> 8) & 0xFF)      ))
70 #define ltohl(b) htoll(b)
71 #define ltohs(b) htols(b)
72 #else
73 #error "Endianess not defined"
74 #endif
75 #endif
76
77
78 static int check_header_fmt(FILE *f, int hsize, int hz)
79 {
80         short format, chans, bysam, bisam;
81         int bysec;
82         int freq;
83         if (hsize < 16) {
84                 ast_log(LOG_WARNING, "Unexpected header size %d\n", ltohl(hsize));
85                 return -1;
86         }
87         if (fread(&format, 1, 2, f) != 2) {
88                 ast_log(LOG_WARNING, "Read failed (format)\n");
89                 return -1;
90         }
91         if (ltohs(format) != 1) {
92                 ast_log(LOG_WARNING, "Not a wav file %d\n", ltohs(format));
93                 return -1;
94         }
95         if (fread(&chans, 1, 2, f) != 2) {
96                 ast_log(LOG_WARNING, "Read failed (format)\n");
97                 return -1;
98         }
99         if (ltohs(chans) != 1) {
100                 ast_log(LOG_WARNING, "Not in mono %d\n", ltohs(chans));
101                 return -1;
102         }
103         if (fread(&freq, 1, 4, f) != 4) {
104                 ast_log(LOG_WARNING, "Read failed (freq)\n");
105                 return -1;
106         }
107         if (((ltohl(freq) != 8000) && (ltohl(freq) != 16000)) ||
108             ((ltohl(freq) == 8000) && (hz != 8000)) ||
109             ((ltohl(freq) == 16000) && (hz != 16000))) {
110                 ast_log(LOG_WARNING, "Unexpected frequency mismatch %d (expecting %d)\n", ltohl(freq),hz);
111                 return -1;
112         }
113         /* Ignore the byte frequency */
114         if (fread(&bysec, 1, 4, f) != 4) {
115                 ast_log(LOG_WARNING, "Read failed (BYTES_PER_SECOND)\n");
116                 return -1;
117         }
118         /* Check bytes per sample */
119         if (fread(&bysam, 1, 2, f) != 2) {
120                 ast_log(LOG_WARNING, "Read failed (BYTES_PER_SAMPLE)\n");
121                 return -1;
122         }
123         if (ltohs(bysam) != 2) {
124                 ast_log(LOG_WARNING, "Can only handle 16bits per sample: %d\n", ltohs(bysam));
125                 return -1;
126         }
127         if (fread(&bisam, 1, 2, f) != 2) {
128                 ast_log(LOG_WARNING, "Read failed (Bits Per Sample): %d\n", ltohs(bisam));
129                 return -1;
130         }
131         /* Skip any additional header */
132         if (fseek(f,ltohl(hsize)-16,SEEK_CUR) == -1 ) {
133                 ast_log(LOG_WARNING, "Failed to skip remaining header bytes: %d\n", ltohl(hsize)-16 );
134                 return -1;
135         }
136         return 0;
137 }
138
139 static int check_header(FILE *f, int hz)
140 {
141         int type, size, formtype;
142         int data;
143         if (fread(&type, 1, 4, f) != 4) {
144                 ast_log(LOG_WARNING, "Read failed (type)\n");
145                 return -1;
146         }
147         if (fread(&size, 1, 4, f) != 4) {
148                 ast_log(LOG_WARNING, "Read failed (size)\n");
149                 return -1;
150         }
151         size = ltohl(size);
152         if (fread(&formtype, 1, 4, f) != 4) {
153                 ast_log(LOG_WARNING, "Read failed (formtype)\n");
154                 return -1;
155         }
156         if (memcmp(&type, "RIFF", 4)) {
157                 ast_log(LOG_WARNING, "Does not begin with RIFF\n");
158                 return -1;
159         }
160         if (memcmp(&formtype, "WAVE", 4)) {
161                 ast_log(LOG_WARNING, "Does not contain WAVE\n");
162                 return -1;
163         }
164         /* Skip any facts and get the first data block */
165         for(;;)
166         { 
167                 char buf[4];
168             
169             /* Begin data chunk */
170             if (fread(&buf, 1, 4, f) != 4) {
171                         ast_log(LOG_WARNING, "Read failed (block header format)\n");
172                         return -1;
173             }
174             /* Data has the actual length of data in it */
175             if (fread(&data, 1, 4, f) != 4) {
176                         ast_log(LOG_WARNING, "Read failed (block '%.4s' header length)\n", buf);
177                         return -1;
178             }
179             data = ltohl(data);
180                 if (memcmp(&buf, "fmt ", 4) == 0) {
181                         if (check_header_fmt(f, data, hz))
182                                 return -1;
183                         continue;
184                 }
185             if(memcmp(buf, "data", 4) == 0 ) 
186                         break;
187                 ast_log(LOG_DEBUG, "Skipping unknown block '%.4s'\n", buf);
188             if (fseek(f,data,SEEK_CUR) == -1 ) {
189                         ast_log(LOG_WARNING, "Failed to skip '%.4s' block: %d\n", buf, data);
190                         return -1;
191             }
192         }
193 #if 0
194         curpos = lseek(fd, 0, SEEK_CUR);
195         truelength = lseek(fd, 0, SEEK_END);
196         lseek(fd, curpos, SEEK_SET);
197         truelength -= curpos;
198 #endif  
199         return data;
200 }
201
202 static int update_header(FILE *f)
203 {
204         off_t cur,end;
205         int datalen,filelen,bytes;
206         
207         cur = ftello(f);
208         fseek(f, 0, SEEK_END);
209         end = ftello(f);
210         /* data starts 44 bytes in */
211         bytes = end - 44;
212         datalen = htoll(bytes);
213         /* chunk size is bytes of data plus 36 bytes of header */
214         filelen = htoll(36 + bytes);
215         
216         if (cur < 0) {
217                 ast_log(LOG_WARNING, "Unable to find our position\n");
218                 return -1;
219         }
220         if (fseek(f, 4, SEEK_SET)) {
221                 ast_log(LOG_WARNING, "Unable to set our position\n");
222                 return -1;
223         }
224         if (fwrite(&filelen, 1, 4, f) != 4) {
225                 ast_log(LOG_WARNING, "Unable to set write file size\n");
226                 return -1;
227         }
228         if (fseek(f, 40, SEEK_SET)) {
229                 ast_log(LOG_WARNING, "Unable to set our position\n");
230                 return -1;
231         }
232         if (fwrite(&datalen, 1, 4, f) != 4) {
233                 ast_log(LOG_WARNING, "Unable to set write datalen\n");
234                 return -1;
235         }
236         if (fseeko(f, cur, SEEK_SET)) {
237                 ast_log(LOG_WARNING, "Unable to return to position\n");
238                 return -1;
239         }
240         return 0;
241 }
242
243 static int write_header(FILE *f, int writehz)
244 {
245         unsigned int hz;
246         unsigned int bhz;
247         unsigned int hs = htoll(16);
248         unsigned short fmt = htols(1);
249         unsigned short chans = htols(1);
250         unsigned short bysam = htols(2);
251         unsigned short bisam = htols(16);
252         unsigned int size = htoll(0);
253
254         if (writehz == 16000) {
255                 hz = htoll(16000);
256                 bhz = htoll(32000);
257         } else {
258                 hz = htoll(8000);
259                 bhz = htoll(16000);
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, (s->fmt->format.id == AST_FORMAT_SLINEAR16 ? 16000 : 8000))) < 0)
321                 return -1;
322         return 0;
323 }
324
325 static int wav_rewrite(struct ast_filestream *s, const char *comment)
326 {
327         /* We don't have any header to read or anything really, but
328            if we did, it would go here.  We also might want to check
329            and be sure it's a valid file.  */
330
331         struct wav_desc *tmp = (struct wav_desc *)s->_private;
332         tmp->hz = (s->fmt->format.id == AST_FORMAT_SLINEAR16 ? 16000 : 8000);
333         if (write_header(s->f,tmp->hz))
334                 return -1;
335         return 0;
336 }
337
338 static void wav_close(struct ast_filestream *s)
339 {
340         char zero = 0;
341         struct wav_desc *fs = (struct wav_desc *)s->_private;
342
343         if ((s->mode & O_RDONLY) == O_RDONLY) {
344                 return;
345         }
346
347         if (s->filename) {
348                 update_header(s->f);
349         }
350
351         /* Pad to even length */
352         if (fs->bytes & 0x1) {
353                 if (!fwrite(&zero, 1, 1, s->f)) {
354                         ast_log(LOG_WARNING, "fwrite() failed: %s\n", strerror(errno));
355                 }
356         }
357 }
358
359 static struct ast_frame *wav_read(struct ast_filestream *s, int *whennext)
360 {
361         int res;
362         int samples;    /* actual samples read */
363 #if __BYTE_ORDER == __BIG_ENDIAN
364         int x;
365         short *tmp;
366 #endif
367         int bytes;
368         off_t here;
369         /* Send a frame from the file to the appropriate channel */
370         struct wav_desc *fs = (struct wav_desc *)s->_private;
371
372         bytes = (fs->hz == 16000 ? (WAV_BUF_SIZE * 2) : WAV_BUF_SIZE);
373
374         here = ftello(s->f);
375         if (fs->maxlen - here < bytes)          /* truncate if necessary */
376                 bytes = fs->maxlen - here;
377         if (bytes < 0)
378                 bytes = 0;
379 /*      ast_debug(1, "here: %d, maxlen: %d, bytes: %d\n", here, s->maxlen, bytes); */
380         s->fr.frametype = AST_FRAME_VOICE;
381         ast_format_set(&s->fr.subclass.format, (fs->hz == 16000 ? AST_FORMAT_SLINEAR16 : AST_FORMAT_SLINEAR), 0);
382         s->fr.mallocd = 0;
383         AST_FRAME_SET_BUFFER(&s->fr, s->buf, AST_FRIENDLY_OFFSET, bytes);
384         
385         if ( (res = fread(s->fr.data.ptr, 1, s->fr.datalen, s->f)) <= 0 ) {
386                 if (res)
387                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
388                 return NULL;
389         }
390         s->fr.datalen = res;
391         s->fr.samples = samples = res / 2;
392
393 #if __BYTE_ORDER == __BIG_ENDIAN
394         tmp = (short *)(s->fr.data.ptr);
395         /* file format is little endian so we need to swap */
396         for( x = 0; x < samples; x++)
397                 tmp[x] = (tmp[x] << 8) | ((tmp[x] & 0xff00) >> 8);
398 #endif
399
400         *whennext = samples;
401         return &s->fr;
402 }
403
404 static int wav_write(struct ast_filestream *fs, struct ast_frame *f)
405 {
406 #if __BYTE_ORDER == __BIG_ENDIAN
407         int x;
408         short tmp[16000], *tmpi;
409 #endif
410         struct wav_desc *s = (struct wav_desc *)fs->_private;
411         int res;
412
413         if (f->frametype != AST_FRAME_VOICE) {
414                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
415                 return -1;
416         }
417         if ((f->subclass.format.id != AST_FORMAT_SLINEAR) && (f->subclass.format.id != AST_FORMAT_SLINEAR16)) {
418                 ast_log(LOG_WARNING, "Asked to write non-SLINEAR%s frame (%s)!\n", s->hz == 16000 ? "16" : "", ast_getformatname(&f->subclass.format));
419                 return -1;
420         }
421         if (ast_format_cmp(&f->subclass.format, &fs->fmt->format) == AST_FORMAT_CMP_NOT_EQUAL) {
422                 ast_log(LOG_WARNING, "Can't change SLINEAR frequency during write\n");
423                 return -1;
424         }
425         if (!f->datalen)
426                 return -1;
427
428 #if __BYTE_ORDER == __BIG_ENDIAN
429         /* swap and write */
430         if (f->datalen > sizeof(tmp)) {
431                 ast_log(LOG_WARNING, "Data length is too long\n");
432                 return -1;
433         }
434         tmpi = f->data.ptr;
435         for (x=0; x < f->datalen/2; x++) 
436                 tmp[x] = (tmpi[x] << 8) | ((tmpi[x] & 0xff00) >> 8);
437
438         if ((res = fwrite(tmp, 1, f->datalen, fs->f)) != f->datalen ) {
439 #else
440         /* just write */
441         if ((res = fwrite(f->data.ptr, 1, f->datalen, fs->f)) != f->datalen ) {
442 #endif
443                 ast_log(LOG_WARNING, "Bad write (%d): %s\n", res, strerror(errno));
444                 return -1;
445         }
446
447         s->bytes += f->datalen;
448                 
449         return 0;
450
451 }
452
453 static int wav_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
454 {
455         off_t min, max, cur, offset = 0, samples;
456
457         samples = sample_offset * 2; /* SLINEAR is 16 bits mono, so sample_offset * 2 = bytes */
458         min = 44; /* wav header is 44 bytes */
459         cur = ftello(fs->f);
460         fseeko(fs->f, 0, SEEK_END);
461         max = ftello(fs->f);
462         if (whence == SEEK_SET)
463                 offset = samples + min;
464         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
465                 offset = samples + cur;
466         else if (whence == SEEK_END)
467                 offset = max - samples;
468         if (whence != SEEK_FORCECUR) {
469                 offset = (offset > max)?max:offset;
470         }
471         /* always protect the header space. */
472         offset = (offset < min)?min:offset;
473         return fseeko(fs->f, offset, SEEK_SET);
474 }
475
476 static int wav_trunc(struct ast_filestream *fs)
477 {
478         if (ftruncate(fileno(fs->f), ftello(fs->f)))
479                 return -1;
480         return update_header(fs->f);
481 }
482
483 static off_t wav_tell(struct ast_filestream *fs)
484 {
485         off_t offset;
486         offset = ftello(fs->f);
487         /* subtract header size to get samples, then divide by 2 for 16 bit samples */
488         return (offset - 44)/2;
489 }
490
491 static struct ast_format_def wav16_f = {
492         .name = "wav16",
493         .exts = "wav16",
494         .open = wav_open,
495         .rewrite = wav_rewrite,
496         .write = wav_write,
497         .seek = wav_seek,
498         .trunc = wav_trunc,
499         .tell = wav_tell,
500         .read = wav_read,
501         .close = wav_close,
502         .buf_size = (WAV_BUF_SIZE * 2) + AST_FRIENDLY_OFFSET,
503         .desc_size = sizeof(struct wav_desc),
504 };
505
506 static struct ast_format_def wav_f = {
507         .name = "wav",
508         .exts = "wav",
509         .open = wav_open,
510         .rewrite = wav_rewrite,
511         .write = wav_write,
512         .seek = wav_seek,
513         .trunc = wav_trunc,
514         .tell = wav_tell,
515         .read = wav_read,
516         .close = wav_close,
517         .buf_size = WAV_BUF_SIZE + AST_FRIENDLY_OFFSET,
518         .desc_size = sizeof(struct wav_desc),
519 };
520
521 static int load_module(void)
522 {
523         ast_format_set(&wav_f.format, AST_FORMAT_SLINEAR, 0);
524         ast_format_set(&wav16_f.format, AST_FORMAT_SLINEAR16, 0);
525         if (ast_format_def_register(&wav_f)
526                 || ast_format_def_register(&wav16_f))
527                 return AST_MODULE_LOAD_FAILURE;
528         return AST_MODULE_LOAD_SUCCESS;
529 }
530
531 static int unload_module(void)
532 {
533         return ast_format_def_unregister(wav_f.name)
534                 || ast_format_def_unregister(wav16_f.name);
535 }
536
537 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Microsoft WAV/WAV16 format (8kHz/16kHz Signed Linear)",
538         .load = load_module,
539         .unload = unload_module,
540         .load_pri = AST_MODPRI_APP_DEPEND
541 );