more doxygenification (issue #5513)
[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  * 
23  */
24  
25 #include <unistd.h>
26 #include <netinet/in.h>
27 #include <arpa/inet.h>
28 #include <stdlib.h>
29 #include <sys/time.h>
30 #include <stdio.h>
31 #include <errno.h>
32 #include <string.h>
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/lock.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/file.h"
41 #include "asterisk/logger.h"
42 #include "asterisk/sched.h"
43 #include "asterisk/module.h"
44 #include "asterisk/endian.h"
45
46 /* Some Ideas for this code came from makewave.c by Jeffrey Chilton */
47
48 /* Portions of the conversion code are by guido@sienanet.it */
49
50 struct ast_filestream {
51         void *reserved[AST_RESERVED_POINTERS];
52         /* This is what a filestream means to us */
53         FILE *f; /* Descriptor */
54         int bytes;
55         int needsgain;
56         struct ast_frame fr;                            /* Frame information */
57         char waste[AST_FRIENDLY_OFFSET];        /* Buffer for sending frames, etc */
58         char empty;                                                     /* Empty character */
59         short buf[160]; 
60         int foffset;
61         int lasttimeout;
62         int maxlen;
63         struct timeval last;
64 };
65
66
67 AST_MUTEX_DEFINE_STATIC(wav_lock);
68 static int glistcnt = 0;
69
70 static char *name = "wav";
71 static char *desc = "Microsoft WAV format (8000hz Signed Linear)";
72 static char *exts = "wav";
73
74 #define BLOCKSIZE 160
75
76 #define GAIN 2          /* 2^GAIN is the multiple to increase the volume by */
77
78 #if __BYTE_ORDER == __LITTLE_ENDIAN
79 #define htoll(b) (b)
80 #define htols(b) (b)
81 #define ltohl(b) (b)
82 #define ltohs(b) (b)
83 #else
84 #if __BYTE_ORDER == __BIG_ENDIAN
85 #define htoll(b)  \
86           (((((b)      ) & 0xFF) << 24) | \
87                ((((b) >>  8) & 0xFF) << 16) | \
88                    ((((b) >> 16) & 0xFF) <<  8) | \
89                    ((((b) >> 24) & 0xFF)      ))
90 #define htols(b) \
91           (((((b)      ) & 0xFF) << 8) | \
92                    ((((b) >> 8) & 0xFF)      ))
93 #define ltohl(b) htoll(b)
94 #define ltohs(b) htols(b)
95 #else
96 #error "Endianess not defined"
97 #endif
98 #endif
99
100
101 static int check_header(FILE *f)
102 {
103         int type, size, formtype;
104         int fmt, hsize;
105         short format, chans, bysam, bisam;
106         int bysec;
107         int freq;
108         int data;
109         if (fread(&type, 1, 4, f) != 4) {
110                 ast_log(LOG_WARNING, "Read failed (type)\n");
111                 return -1;
112         }
113         if (fread(&size, 1, 4, f) != 4) {
114                 ast_log(LOG_WARNING, "Read failed (size)\n");
115                 return -1;
116         }
117         size = ltohl(size);
118         if (fread(&formtype, 1, 4, f) != 4) {
119                 ast_log(LOG_WARNING, "Read failed (formtype)\n");
120                 return -1;
121         }
122         if (memcmp(&type, "RIFF", 4)) {
123                 ast_log(LOG_WARNING, "Does not begin with RIFF\n");
124                 return -1;
125         }
126         if (memcmp(&formtype, "WAVE", 4)) {
127                 ast_log(LOG_WARNING, "Does not contain WAVE\n");
128                 return -1;
129         }
130         if (fread(&fmt, 1, 4, f) != 4) {
131                 ast_log(LOG_WARNING, "Read failed (fmt)\n");
132                 return -1;
133         }
134         if (memcmp(&fmt, "fmt ", 4)) {
135                 ast_log(LOG_WARNING, "Does not say fmt\n");
136                 return -1;
137         }
138         if (fread(&hsize, 1, 4, f) != 4) {
139                 ast_log(LOG_WARNING, "Read failed (formtype)\n");
140                 return -1;
141         }
142         if (ltohl(hsize) < 16) {
143                 ast_log(LOG_WARNING, "Unexpected header size %d\n", ltohl(hsize));
144                 return -1;
145         }
146         if (fread(&format, 1, 2, f) != 2) {
147                 ast_log(LOG_WARNING, "Read failed (format)\n");
148                 return -1;
149         }
150         if (ltohs(format) != 1) {
151                 ast_log(LOG_WARNING, "Not a wav file %d\n", ltohs(format));
152                 return -1;
153         }
154         if (fread(&chans, 1, 2, f) != 2) {
155                 ast_log(LOG_WARNING, "Read failed (format)\n");
156                 return -1;
157         }
158         if (ltohs(chans) != 1) {
159                 ast_log(LOG_WARNING, "Not in mono %d\n", ltohs(chans));
160                 return -1;
161         }
162         if (fread(&freq, 1, 4, f) != 4) {
163                 ast_log(LOG_WARNING, "Read failed (freq)\n");
164                 return -1;
165         }
166         if (ltohl(freq) != 8000) {
167                 ast_log(LOG_WARNING, "Unexpected freqency %d\n", ltohl(freq));
168                 return -1;
169         }
170         /* Ignore the byte frequency */
171         if (fread(&bysec, 1, 4, f) != 4) {
172                 ast_log(LOG_WARNING, "Read failed (BYTES_PER_SECOND)\n");
173                 return -1;
174         }
175         /* Check bytes per sample */
176         if (fread(&bysam, 1, 2, f) != 2) {
177                 ast_log(LOG_WARNING, "Read failed (BYTES_PER_SAMPLE)\n");
178                 return -1;
179         }
180         if (ltohs(bysam) != 2) {
181                 ast_log(LOG_WARNING, "Can only handle 16bits per sample: %d\n", ltohs(bysam));
182                 return -1;
183         }
184         if (fread(&bisam, 1, 2, f) != 2) {
185                 ast_log(LOG_WARNING, "Read failed (Bits Per Sample): %d\n", ltohs(bisam));
186                 return -1;
187         }
188         /* Skip any additional header */
189         if (fseek(f,ltohl(hsize)-16,SEEK_CUR) == -1 ) {
190                 ast_log(LOG_WARNING, "Failed to skip remaining header bytes: %d\n", ltohl(hsize)-16 );
191                 return -1;
192         }
193         /* Skip any facts and get the first data block */
194         for(;;)
195         { 
196                 char buf[4];
197             
198             /* Begin data chunk */
199             if (fread(&buf, 1, 4, f) != 4) {
200                         ast_log(LOG_WARNING, "Read failed (data)\n");
201                         return -1;
202             }
203             /* Data has the actual length of data in it */
204             if (fread(&data, 1, 4, f) != 4) {
205                         ast_log(LOG_WARNING, "Read failed (data)\n");
206                         return -1;
207             }
208             data = ltohl(data);
209             if(memcmp(buf, "data", 4) == 0 ) 
210                         break;
211             if(memcmp(buf, "fact", 4) != 0 ) {
212                         ast_log(LOG_WARNING, "Unknown block - not fact or data\n");
213                         return -1;
214             }
215             if (fseek(f,data,SEEK_CUR) == -1 ) {
216                         ast_log(LOG_WARNING, "Failed to skip fact block: %d\n", data );
217                         return -1;
218             }
219         }
220 #if 0
221         curpos = lseek(fd, 0, SEEK_CUR);
222         truelength = lseek(fd, 0, SEEK_END);
223         lseek(fd, curpos, SEEK_SET);
224         truelength -= curpos;
225 #endif  
226         return data;
227 }
228
229 static int update_header(FILE *f)
230 {
231         off_t cur,end;
232         int datalen,filelen,bytes;
233         
234         
235         cur = ftell(f);
236         fseek(f, 0, SEEK_END);
237         end = ftell(f);
238         /* data starts 44 bytes in */
239         bytes = end - 44;
240         datalen = htoll(bytes);
241         /* chunk size is bytes of data plus 36 bytes of header */
242         filelen = htoll(36 + bytes);
243         
244         if (cur < 0) {
245                 ast_log(LOG_WARNING, "Unable to find our position\n");
246                 return -1;
247         }
248         if (fseek(f, 4, SEEK_SET)) {
249                 ast_log(LOG_WARNING, "Unable to set our position\n");
250                 return -1;
251         }
252         if (fwrite(&filelen, 1, 4, f) != 4) {
253                 ast_log(LOG_WARNING, "Unable to set write file size\n");
254                 return -1;
255         }
256         if (fseek(f, 40, SEEK_SET)) {
257                 ast_log(LOG_WARNING, "Unable to set our position\n");
258                 return -1;
259         }
260         if (fwrite(&datalen, 1, 4, f) != 4) {
261                 ast_log(LOG_WARNING, "Unable to set write datalen\n");
262                 return -1;
263         }
264         if (fseek(f, cur, SEEK_SET)) {
265                 ast_log(LOG_WARNING, "Unable to return to position\n");
266                 return -1;
267         }
268         return 0;
269 }
270
271 static int write_header(FILE *f)
272 {
273         unsigned int hz=htoll(8000);
274         unsigned int bhz = htoll(16000);
275         unsigned int hs = htoll(16);
276         unsigned short fmt = htols(1);
277         unsigned short chans = htols(1);
278         unsigned short bysam = htols(2);
279         unsigned short bisam = htols(16);
280         unsigned int size = htoll(0);
281         /* Write a wav header, ignoring sizes which will be filled in later */
282         fseek(f,0,SEEK_SET);
283         if (fwrite("RIFF", 1, 4, f) != 4) {
284                 ast_log(LOG_WARNING, "Unable to write header\n");
285                 return -1;
286         }
287         if (fwrite(&size, 1, 4, f) != 4) {
288                 ast_log(LOG_WARNING, "Unable to write header\n");
289                 return -1;
290         }
291         if (fwrite("WAVEfmt ", 1, 8, f) != 8) {
292                 ast_log(LOG_WARNING, "Unable to write header\n");
293                 return -1;
294         }
295         if (fwrite(&hs, 1, 4, f) != 4) {
296                 ast_log(LOG_WARNING, "Unable to write header\n");
297                 return -1;
298         }
299         if (fwrite(&fmt, 1, 2, f) != 2) {
300                 ast_log(LOG_WARNING, "Unable to write header\n");
301                 return -1;
302         }
303         if (fwrite(&chans, 1, 2, f) != 2) {
304                 ast_log(LOG_WARNING, "Unable to write header\n");
305                 return -1;
306         }
307         if (fwrite(&hz, 1, 4, f) != 4) {
308                 ast_log(LOG_WARNING, "Unable to write header\n");
309                 return -1;
310         }
311         if (fwrite(&bhz, 1, 4, f) != 4) {
312                 ast_log(LOG_WARNING, "Unable to write header\n");
313                 return -1;
314         }
315         if (fwrite(&bysam, 1, 2, f) != 2) {
316                 ast_log(LOG_WARNING, "Unable to write header\n");
317                 return -1;
318         }
319         if (fwrite(&bisam, 1, 2, f) != 2) {
320                 ast_log(LOG_WARNING, "Unable to write header\n");
321                 return -1;
322         }
323         if (fwrite("data", 1, 4, f) != 4) {
324                 ast_log(LOG_WARNING, "Unable to write header\n");
325                 return -1;
326         }
327         if (fwrite(&size, 1, 4, f) != 4) {
328                 ast_log(LOG_WARNING, "Unable to write header\n");
329                 return -1;
330         }
331         return 0;
332 }
333
334 static struct ast_filestream *wav_open(FILE *f)
335 {
336         /* We don't have any header to read or anything really, but
337            if we did, it would go here.  We also might want to check
338            and be sure it's a valid file.  */
339         struct ast_filestream *tmp;
340         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
341                 memset(tmp, 0, sizeof(struct ast_filestream));
342                 if ((tmp->maxlen = check_header(f)) < 0) {
343                         free(tmp);
344                         return NULL;
345                 }
346                 if (ast_mutex_lock(&wav_lock)) {
347                         ast_log(LOG_WARNING, "Unable to lock wav list\n");
348                         free(tmp);
349                         return NULL;
350                 }
351                 tmp->f = f;
352                 tmp->needsgain = 1;
353                 tmp->fr.data = tmp->buf;
354                 tmp->fr.frametype = AST_FRAME_VOICE;
355                 tmp->fr.subclass = AST_FORMAT_SLINEAR;
356                 /* datalen will vary for each frame */
357                 tmp->fr.src = name;
358                 tmp->fr.mallocd = 0;
359                 tmp->bytes = 0;
360                 glistcnt++;
361                 ast_mutex_unlock(&wav_lock);
362                 ast_update_use_count();
363         }
364         return tmp;
365 }
366
367 static struct ast_filestream *wav_rewrite(FILE *f, const char *comment)
368 {
369         /* We don't have any header to read or anything really, but
370            if we did, it would go here.  We also might want to check
371            and be sure it's a valid file.  */
372         struct ast_filestream *tmp;
373         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
374                 memset(tmp, 0, sizeof(struct ast_filestream));
375                 if (write_header(f)) {
376                         free(tmp);
377                         return NULL;
378                 }
379                 if (ast_mutex_lock(&wav_lock)) {
380                         ast_log(LOG_WARNING, "Unable to lock wav list\n");
381                         free(tmp);
382                         return NULL;
383                 }
384                 tmp->f = f;
385                 glistcnt++;
386                 ast_mutex_unlock(&wav_lock);
387                 ast_update_use_count();
388         } else
389                 ast_log(LOG_WARNING, "Out of memory\n");
390         return tmp;
391 }
392
393 static void wav_close(struct ast_filestream *s)
394 {
395         char zero = 0;
396         if (ast_mutex_lock(&wav_lock)) {
397                 ast_log(LOG_WARNING, "Unable to lock wav list\n");
398                 return;
399         }
400         glistcnt--;
401         ast_mutex_unlock(&wav_lock);
402         ast_update_use_count();
403         /* Pad to even length */
404         if (s->bytes & 0x1)
405                 fwrite(&zero, 1, 1, s->f);
406         fclose(s->f);
407         free(s);
408         s = NULL;
409 }
410
411 static struct ast_frame *wav_read(struct ast_filestream *s, int *whennext)
412 {
413         int res;
414         int delay;
415         int x;
416         short tmp[sizeof(s->buf) / 2];
417         int bytes = sizeof(tmp);
418         off_t here;
419         /* Send a frame from the file to the appropriate channel */
420         here = ftell(s->f);
421         if ((s->maxlen - here) < bytes)
422                 bytes = s->maxlen - here;
423         if (bytes < 0)
424                 bytes = 0;
425 /*      ast_log(LOG_DEBUG, "here: %d, maxlen: %d, bytes: %d\n", here, s->maxlen, bytes); */
426         
427         if ( (res = fread(tmp, 1, bytes, s->f)) <= 0 ) {
428                 if (res) {
429                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
430                 }
431                 return NULL;
432         }
433
434 #if __BYTE_ORDER == __BIG_ENDIAN
435         for( x = 0; x < sizeof(tmp)/2; x++) tmp[x] = (tmp[x] << 8) | ((tmp[x] & 0xff00) >> 8);
436 #endif
437
438         if (s->needsgain) {
439                 for (x=0;x<sizeof(tmp)/2;x++)
440                         if (tmp[x] & ((1 << GAIN) - 1)) {
441                                 /* If it has data down low, then it's not something we've artificially increased gain
442                                    on, so we don't need to gain adjust it */
443                                 s->needsgain = 0;
444                         }
445         }
446         if (s->needsgain) {
447                 for (x=0;x<sizeof(tmp)/2;x++) {
448                         s->buf[x] = tmp[x] >> GAIN;
449                 }
450         } else {
451                 memcpy(s->buf, tmp, sizeof(s->buf));
452         }
453                         
454         delay = res / 2;
455         s->fr.frametype = AST_FRAME_VOICE;
456         s->fr.subclass = AST_FORMAT_SLINEAR;
457         s->fr.offset = AST_FRIENDLY_OFFSET;
458         s->fr.datalen = res;
459         s->fr.data = s->buf;
460         s->fr.mallocd = 0;
461         s->fr.samples = delay;
462         *whennext = delay;
463         return &s->fr;
464 }
465
466 static int wav_write(struct ast_filestream *fs, struct ast_frame *f)
467 {
468         int res = 0;
469         int x;
470         short tmp[8000], *tmpi;
471         float tmpf;
472         if (f->frametype != AST_FRAME_VOICE) {
473                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
474                 return -1;
475         }
476         if (f->subclass != AST_FORMAT_SLINEAR) {
477                 ast_log(LOG_WARNING, "Asked to write non-SLINEAR frame (%d)!\n", f->subclass);
478                 return -1;
479         }
480         if (f->datalen > sizeof(tmp)) {
481                 ast_log(LOG_WARNING, "Data length is too long\n");
482                 return -1;
483         }
484         if (!f->datalen)
485                 return -1;
486
487 #if 0
488         printf("Data Length: %d\n", f->datalen);
489 #endif  
490
491         if (fs->buf) {
492                 tmpi = f->data;
493                 /* Volume adjust here to accomodate */
494                 for (x=0;x<f->datalen/2;x++) {
495                         tmpf = ((float)tmpi[x]) * ((float)(1 << GAIN));
496                         if (tmpf > 32767.0)
497                                 tmpf = 32767.0;
498                         if (tmpf < -32768.0)
499                                 tmpf = -32768.0;
500                         tmp[x] = tmpf;
501                         tmp[x] &= ~((1 << GAIN) - 1);
502
503 #if __BYTE_ORDER == __BIG_ENDIAN
504                         tmp[x] = (tmp[x] << 8) | ((tmp[x] & 0xff00) >> 8);
505 #endif
506
507                 }
508                 if ((fwrite(tmp, 1, f->datalen, fs->f) != f->datalen) ) {
509                         ast_log(LOG_WARNING, "Bad write (%d): %s\n", res, strerror(errno));
510                         return -1;
511                 }
512         } else {
513                 ast_log(LOG_WARNING, "Cannot write data to file.\n");
514                 return -1;
515         }
516         
517         fs->bytes += f->datalen;
518         update_header(fs->f);
519                 
520         return 0;
521
522 }
523
524 static int wav_seek(struct ast_filestream *fs, long sample_offset, int whence)
525 {
526         off_t min,max,cur;
527         long offset=0,samples;
528         
529         samples = sample_offset * 2; /* SLINEAR is 16 bits mono, so sample_offset * 2 = bytes */
530         min = 44; /* wav header is 44 bytes */
531         cur = ftell(fs->f);
532         fseek(fs->f, 0, SEEK_END);
533         max = ftell(fs->f);
534         if (whence == SEEK_SET)
535                 offset = samples + min;
536         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
537                 offset = samples + cur;
538         else if (whence == SEEK_END)
539                 offset = max - samples;
540         if (whence != SEEK_FORCECUR) {
541                 offset = (offset > max)?max:offset;
542         }
543         /* always protect the header space. */
544         offset = (offset < min)?min:offset;
545         return fseek(fs->f,offset,SEEK_SET);
546 }
547
548 static int wav_trunc(struct ast_filestream *fs)
549 {
550         if (ftruncate(fileno(fs->f), ftell(fs->f)))
551                 return -1;
552         return update_header(fs->f);
553 }
554
555 static long wav_tell(struct ast_filestream *fs)
556 {
557         off_t offset;
558         offset = ftell(fs->f);
559         /* subtract header size to get samples, then divide by 2 for 16 bit samples */
560         return (offset - 44)/2;
561 }
562
563 static char *wav_getcomment(struct ast_filestream *s)
564 {
565         return NULL;
566 }
567
568 int load_module()
569 {
570         return ast_format_register(name, exts, AST_FORMAT_SLINEAR,
571                                                                 wav_open,
572                                                                 wav_rewrite,
573                                                                 wav_write,
574                                                                 wav_seek,
575                                                                 wav_trunc,
576                                                                 wav_tell,
577                                                                 wav_read,
578                                                                 wav_close,
579                                                                 wav_getcomment);
580                                                                 
581                                                                 
582 }
583
584 int unload_module()
585 {
586         return ast_format_unregister(name);
587 }       
588
589 int usecount()
590 {
591         return glistcnt;
592 }
593
594 char *description()
595 {
596         return desc;
597 }
598
599
600 char *key()
601 {
602         return ASTERISK_GPL_KEY;
603 }