apps/codecs/wav.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2005 Dave Chapman
  11  * Copyright (C) 2009 Yoshihisa Uchida
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version 2
  16  * of the License, or (at your option) any later version.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ****************************************************************************/
  22
  23 #include "codeclib.h"
  24 #include "codecs/libpcm/support_formats.h"
  25
  26 CODEC_HEADER
  27
  28 /* WAVE (RIFF) codec:
  29  *
  30  *  For a good documentation on WAVE files, see:
  31  *  http://www.tsp.ece.mcgill.ca/MMSP/Documents/AudioFormats/WAVE/WAVE.html
  32  *  and
  33  *  http://www.sonicspot.com/guide/wavefiles.html
  34  *
  35  *  For sample WAV files, see:
  36  *  http://www.tsp.ece.mcgill.ca/MMSP/Documents/AudioFormats/WAVE/Samples.html
  37  *
  38  */
  39
  40 #define PCM_SAMPLE_SIZE (4096*2)
  41
  42 static int32_t samples[PCM_SAMPLE_SIZE] IBSS_ATTR;
  43
  44 /* This codec support WAVE files with the following formats: */
  45 enum
  46 {
  47     WAVE_FORMAT_UNKNOWN = 0x0000, /* Microsoft Unknown Wave Format */
  48     WAVE_FORMAT_PCM = 0x0001,   /* Microsoft PCM Format */
  49     WAVE_FORMAT_ADPCM = 0x0002, /* Microsoft ADPCM Format */
  50     WAVE_FORMAT_IEEE_FLOAT = 0x0003, /* IEEE Float */
  51     WAVE_FORMAT_ALAW = 0x0006,  /* Microsoft ALAW */
  52     WAVE_FORMAT_MULAW = 0x0007, /* Microsoft MULAW */
  53     WAVE_FORMAT_DVI_ADPCM = 0x0011, /* Intel's DVI ADPCM */
  54     WAVE_FORMAT_DIALOGIC_OKI_ADPCM = 0x0017, /* Dialogic OKI ADPCM */
  55     WAVE_FORMAT_YAMAHA_ADPCM = 0x0020, /* Yamaha ADPCM */
  56     WAVE_FORMAT_XBOX_ADPCM = 0x0069, /* XBOX ADPCM */
  57     IBM_FORMAT_MULAW = 0x0101,  /* same as WAVE_FORMAT_MULAW */
  58     IBM_FORMAT_ALAW = 0x0102,   /* same as WAVE_FORMAT_ALAW */
  59     WAVE_FORMAT_SWF_ADPCM = 0x5346, /* Adobe SWF ADPCM */
  60     WAVE_FORMAT_EXTENSIBLE = 0xFFFE
  61 };
  62
  63 const struct pcm_entry wave_codecs[] = {
  64     { WAVE_FORMAT_UNKNOWN,            0                            },
  65     { WAVE_FORMAT_PCM,                get_linear_pcm_codec         },
  66     { WAVE_FORMAT_ADPCM,              get_ms_adpcm_codec           },
  67     { WAVE_FORMAT_IEEE_FLOAT,         get_ieee_float_codec         },
  68     { WAVE_FORMAT_ALAW,               get_itut_g711_alaw_codec     },
  69     { WAVE_FORMAT_MULAW,              get_itut_g711_mulaw_codec    },
  70     { WAVE_FORMAT_DVI_ADPCM,          get_dvi_adpcm_codec          },
  71     { WAVE_FORMAT_DIALOGIC_OKI_ADPCM, get_dialogic_oki_adpcm_codec },
  72     { WAVE_FORMAT_YAMAHA_ADPCM,       get_yamaha_adpcm_codec       },
  73     { WAVE_FORMAT_XBOX_ADPCM,         get_dvi_adpcm_codec          },
  74     { IBM_FORMAT_MULAW,               get_itut_g711_mulaw_codec    },
  75     { IBM_FORMAT_ALAW,                get_itut_g711_alaw_codec     },
  76     { WAVE_FORMAT_SWF_ADPCM,          get_swf_adpcm_codec          },
  77 };
  78
  79 #define NUM_FORMATS 13
  80
  81 static const struct pcm_codec *get_wave_codec(uint32_t formattag)
  82 {
  83     int i;
  84
  85     for (i = 0; i < NUM_FORMATS; i++)
  86     {
  87         if (wave_codecs[i].format_tag == formattag)
  88         {
  89             if (wave_codecs[i].get_codec)
  90                 return wave_codecs[i].get_codec();
  91             return 0;
  92         }
  93     }
  94     return 0;
  95 }
  96
  97 static struct pcm_format format;
  98 static uint32_t bytesdone;
  99
 100 static bool set_msadpcm_coeffs(const uint8_t *buf)
 101 {
 102     int i;
 103     int num;
 104     int size;
 105
 106     buf += 4; /* skip 'fmt ' */
 107     size = buf[0] | (buf[1] << 8) | (buf[1] << 16) | (buf[1] << 24);
 108     if (size < 50)
 109     {
 110         DEBUGF("CODEC_ERROR: microsoft adpcm 'fmt ' chunk size=%lu < 50\n",
 111                              (unsigned long)size);
 112         return false;
 113     }
 114
 115     /* get nNumCoef */
 116     buf += 24;
 117     num = buf[0] | (buf[1] << 8);
 118
 119     /*
 120      * In many case, nNumCoef is 7.
 121      * Depending upon the encoder, as for this value there is a possibility of
 122      * increasing more.
 123      * If you found the file where this value exceeds 7, please report.
 124      */
 125     if (num != MSADPCM_NUM_COEFF)
 126     {
 127         DEBUGF("CODEC_ERROR: microsoft adpcm nNumCoef=%d != 7\n", num);
 128         return false;
 129     }
 130
 131     /* get aCoeffs */
 132     buf += 2;
 133     for (i = 0; i < MSADPCM_NUM_COEFF; i++)
 134     {
 135         format.coeffs[i][0] = buf[0] | (SE(buf[1]) << 8);
 136         format.coeffs[i][1] = buf[2] | (SE(buf[3]) << 8);
 137         buf += 4;
 138     }
 139
 140     return true;
 141 }
 142
 143 static uint8_t *read_buffer(size_t *realsize)
 144 {
 145     uint8_t *buffer = (uint8_t *)ci->request_buffer(realsize, format.chunksize);
 146     if (bytesdone + (*realsize) > format.numbytes)
 147         *realsize = format.numbytes - bytesdone;
 148     bytesdone += *realsize;
 149     ci->advance_buffer(*realsize);
 150     return buffer;
 151 }
 152
 153 /* this is the codec entry point */
 154 enum codec_status codec_main(void)
 155 {
 156     int status = CODEC_OK;
 157     uint32_t decodedsamples;
 158     size_t n;
 159     int bufcount;
 160     int endofstream;
 161     unsigned char *buf;
 162     uint8_t *wavbuf;
 163     off_t firstblockposn;     /* position of the first block in file */
 164     const struct pcm_codec *codec;
 165     uint32_t size;
 166
 167     /* Generic codec initialisation */
 168     ci->configure(DSP_SET_SAMPLE_DEPTH, PCM_OUTPUT_DEPTH-1);
 169
 170 next_track:
 171     if (codec_init()) {
 172         DEBUGF("codec_init() error\n");
 173         status = CODEC_ERROR;
 174         goto exit;
 175     }
 176
 177     while (!*ci->taginfo_ready && !ci->stop_codec)
 178         ci->sleep(1);
 179
 180     codec_set_replaygain(ci->id3);
 181
 182     /* Need to save offset for later use (cleared indirectly by advance_buffer) */
 183     bytesdone = ci->id3->offset;
 184
 185     /* get RIFF chunk header */
 186     buf = ci->request_buffer(&n, 12);
 187     if (n < 12) {
 188         DEBUGF("request_buffer error\n");
 189         status = CODEC_ERROR;
 190         goto done;
 191     }
 192     if ((memcmp(buf, "RIFF", 4) != 0) || (memcmp(&buf[8], "WAVE", 4) != 0)) {
 193         DEBUGF("CODEC_ERROR: missing riff header\n");
 194         status = CODEC_ERROR;
 195         goto done;
 196     }
 197
 198     /* advance to first WAVE chunk */
 199     ci->advance_buffer(12);
 200
 201     firstblockposn = 12;
 202     ci->memset(&format, 0, sizeof(struct pcm_format));
 203     format.is_signed = true;
 204     format.is_little_endian = true;
 205
 206     decodedsamples = 0;
 207     codec = 0;
 208
 209     /* iterate over WAVE chunks until the 'data' chunk, which should be after the 'fmt ' chunk */
 210     while (true) {
 211         /* get WAVE chunk header */
 212         buf = ci->request_buffer(&n, 1024);
 213         if (n < 8) {
 214             DEBUGF("data chunk request_buffer error\n");
 215             /* no more chunks, 'data' chunk must not have been found */
 216             status = CODEC_ERROR;
 217             goto done;
 218         }
 219
 220         /* chunkSize */
 221         size = (buf[4]|(buf[5]<<8)|(buf[6]<<16)|(buf[7]<<24));
 222         if (memcmp(buf, "fmt ", 4) == 0) {
 223             if (size < 16) {
 224                 DEBUGF("CODEC_ERROR: 'fmt ' chunk size=%lu < 16\n",
 225                        (unsigned long)size);
 226                 status = CODEC_ERROR;
 227                 goto done;
 228             }
 229             /* wFormatTag */
 230             format.formattag=buf[8]|(buf[9]<<8);
 231             /* wChannels */
 232             format.channels=buf[10]|(buf[11]<<8);
 233             /* skipping dwSamplesPerSec */
 234             /* skipping dwAvgBytesPerSec */
 235             /* wBlockAlign */
 236             format.blockalign=buf[20]|(buf[21]<<8);
 237             /* wBitsPerSample */
 238             format.bitspersample=buf[22]|(buf[23]<<8);
 239             if (format.formattag != WAVE_FORMAT_PCM) {
 240                 if (size < 18) {
 241                     /* this is not a fatal error with some formats,
 242                      * we'll see later if we can't decode it */
 243                     DEBUGF("CODEC_WARNING: non-PCM WAVE (formattag=0x%x) "
 244                            "doesn't have ext. fmt descr (chunksize=%d<18).\n",
 245                            (unsigned int)format.formattag, (int)size);
 246                 }
 247                 else
 248                 {
 249                     if (format.formattag != WAVE_FORMAT_EXTENSIBLE)
 250                         format.samplesperblock = buf[26]|(buf[27]<<8);
 251                     else
 252                     {
 253                         format.size = buf[24]|(buf[25]<<8);
 254                         if (format.size < 22) {
 255                             DEBUGF("CODEC_ERROR: WAVE_FORMAT_EXTENSIBLE is "
 256                                    "missing extension\n");
 257                             status = CODEC_ERROR;
 258                             goto done;
 259                         }
 260                         /* wValidBitsPerSample */
 261                         format.bitspersample = buf[26]|(buf[27]<<8);
 262                         /* skipping dwChannelMask (4bytes) */
 263                         /* SubFormat (only get the first two bytes) */
 264                         format.formattag = buf[32]|(buf[33]<<8);
 265                     }
 266                 }
 267             }
 268
 269             /* msadpcm specific */
 270             if (format.formattag == WAVE_FORMAT_ADPCM)
 271             {
 272                 if (!set_msadpcm_coeffs(buf))
 273                 {
 274                     status = CODEC_ERROR;
 275                     goto done;
 276                 }
 277             }
 278
 279             /* get codec */
 280             codec = get_wave_codec(format.formattag);
 281             if (!codec)
 282             {
 283                 DEBUGF("CODEC_ERROR: unsupported wave format 0x%x\n",
 284                     (unsigned int) format.formattag);
 285                 status = CODEC_ERROR;
 286                 goto done;
 287             }
 288
 289             /* riff 8bit linear pcm is unsigned */
 290             if (format.formattag == WAVE_FORMAT_PCM && format.bitspersample == 8)
 291                 format.is_signed = false;
 292
 293             /* set format, parse codec specific tag, check format, and calculate chunk size */
 294             if (!codec->set_format(&format))
 295             {
 296                 status = CODEC_ERROR;
 297                 goto done;
 298             }
 299         } else if (memcmp(buf, "data", 4) == 0) {
 300             format.numbytes = size;
 301             /* advance to start of data */
 302             ci->advance_buffer(8);
 303             firstblockposn += 8;
 304             break;
 305         } else if (memcmp(buf, "fact", 4) == 0) {
 306             /* dwSampleLength */
 307             if (size >= 4)
 308                 format.totalsamples =
 309                              (buf[8]|(buf[9]<<8)|(buf[10]<<16)|(buf[11]<<24));
 310         } else {
 311             DEBUGF("unknown WAVE chunk: '%c%c%c%c', size=%lu\n",
 312                    buf[0], buf[1], buf[2], buf[3], (unsigned long)size);
 313         }
 314
 315         /* go to next chunk (even chunk sizes must be padded) */
 316         size += 8 + (size & 0x01);
 317
 318         ci->advance_buffer(size);
 319         firstblockposn += size;
 320     }
 321
 322     if (!codec)
 323     {
 324         DEBUGF("CODEC_ERROR: 'fmt ' chunk not found\n");
 325         status = CODEC_ERROR;
 326         goto done;
 327     }
 328
 329     /* common format check */
 330     if (format.channels == 0) {
 331         DEBUGF("CODEC_ERROR: 'fmt ' chunk not found or 0-channels file\n");
 332         status = CODEC_ERROR;
 333         goto done;
 334     }
 335     if (format.samplesperblock == 0) {
 336         DEBUGF("CODEC_ERROR: 'fmt ' chunk not found or 0-wSamplesPerBlock file\n");
 337         status = CODEC_ERROR;
 338         goto done;
 339     }
 340     if (format.blockalign == 0)
 341     {
 342         DEBUGF("CODEC_ERROR: 'fmt ' chunk not found or 0-blockalign file\n");
 343         status = CODEC_ERROR;
 344         goto done;
 345     }
 346     if (format.numbytes == 0) {
 347         DEBUGF("CODEC_ERROR: 'data' chunk not found or has zero-length\n");
 348         status = CODEC_ERROR;
 349         goto done;
 350     }
 351
 352     /* check chunksize */
 353     if ((format.chunksize / format.blockalign) * format.samplesperblock * format.channels
 354            > PCM_SAMPLE_SIZE)
 355         format.chunksize = (PCM_SAMPLE_SIZE / format.blockalign) * format.blockalign;
 356     if (format.chunksize == 0)
 357     {
 358         DEBUGF("CODEC_ERROR: chunksize is 0\n");
 359         status = CODEC_ERROR;
 360         goto done;
 361     }
 362
 363     ci->configure(DSP_SWITCH_FREQUENCY, ci->id3->frequency);
 364     if (format.channels == 2) {
 365         ci->configure(DSP_SET_STEREO_MODE, STEREO_INTERLEAVED);
 366     } else if (format.channels == 1) {
 367         ci->configure(DSP_SET_STEREO_MODE, STEREO_MONO);
 368     } else {
 369         DEBUGF("CODEC_ERROR: more than 2 channels\n");
 370         status = CODEC_ERROR;
 371         goto done;
 372     }
 373
 374     /* make sure we're at the correct offset */
 375     if (bytesdone > (uint32_t) firstblockposn) {
 376         /* Round down to previous block */
 377         struct pcm_pos *newpos = codec->get_seek_pos(bytesdone - firstblockposn,
 378                                                      PCM_SEEK_POS, &read_buffer);
 379
 380         if (newpos->pos > format.numbytes)
 381             goto done;
 382         if (ci->seek_buffer(firstblockposn + newpos->pos))
 383         {
 384             bytesdone      = newpos->pos;
 385             decodedsamples = newpos->samples;
 386         }
 387         ci->seek_complete();
 388     } else {
 389         /* already where we need to be */
 390         bytesdone = 0;
 391     }
 392
 393     /* The main decoder loop */
 394     endofstream = 0;
 395
 396     while (!endofstream) {
 397         ci->yield();
 398         if (ci->stop_codec || ci->new_track) {
 399             break;
 400         }
 401
 402         if (ci->seek_time) {
 403             struct pcm_pos *newpos = codec->get_seek_pos(ci->seek_time, PCM_SEEK_TIME,
 404                                                          &read_buffer);
 405
 406             if (newpos->pos > format.numbytes)
 407                 break;
 408             if (ci->seek_buffer(firstblockposn + newpos->pos))
 409             {
 410                 bytesdone      = newpos->pos;
 411                 decodedsamples = newpos->samples;
 412             }
 413             ci->seek_complete();
 414         }
 415
 416         wavbuf = (uint8_t *)ci->request_buffer(&n, format.chunksize);
 417         if (n == 0)
 418             break; /* End of stream */
 419         if (bytesdone + n > format.numbytes) {
 420             n = format.numbytes - bytesdone;
 421             endofstream = 1;
 422         }
 423
 424         status = codec->decode(wavbuf, n, samples, &bufcount);
 425         if (status == CODEC_ERROR)
 426         {
 427             DEBUGF("codec error\n");
 428             goto done;
 429         }
 430
 431         ci->pcmbuf_insert(samples, NULL, bufcount);
 432         ci->advance_buffer(n);
 433         bytesdone += n;
 434         decodedsamples += bufcount;
 435
 436         if (bytesdone >= format.numbytes)
 437             endofstream = 1;
 438         ci->set_elapsed(decodedsamples*1000LL/ci->id3->frequency);
 439     }
 440     status = CODEC_OK;
 441
 442 done:
 443     if (ci->request_next_track())
 444         goto next_track;
 445
 446 exit:
 447     return status;
 448 }