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