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