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