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