git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A5_SAMA5D2x_Xplained_IAR/AtmelFiles/utils/wav.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2015, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 #ifndef WAV_H\r
  31 #define WAV_H\r
  32 \r
  33 /*----------------------------------------------------------------------------\r
  34  *        Headers\r
  35  *----------------------------------------------------------------------------*/\r
  36 \r
  37 #include <stdbool.h>\r
  38 #include <stdint.h>\r
  39 \r
  40 /*----------------------------------------------------------------------------\r
  41  *        Types\r
  42  *----------------------------------------------------------------------------*/\r
  43 \r
  44 /** Standard WAV file header information. */\r
  45 struct _wav_header {\r
  46         /** Contains the letters "RIFF" in ASCII form. */\r
  47         uint32_t chunk_id;\r
  48         /** Size of the rest of the chunk following this number. */\r
  49         uint32_t chunk_size;\r
  50         /** Contains the letters "WAVE". */\r
  51         uint32_t format;\r
  52         /** Contains the letters "fmt ". */\r
  53         uint32_t subchunk1_id;\r
  54         /** 16 for PCM.  This is the size of the rest of the Subchunk which follows this number. */\r
  55         uint32_t subchunk1_size;\r
  56         /** PCM = 1 (i.e. Linear quantization). Values other than 1 indicate some form of compression. */\r
  57         uint16_t audio_format;\r
  58         /** Mono = 1, Stereo = 2, etc. */\r
  59         uint16_t num_channels;\r
  60         /** 8000, 44100, etc. */\r
  61         uint32_t sample_rate;\r
  62         /** SampleRate * NumChannels * BitsPerSample/8 */\r
  63         uint32_t byte_rate;\r
  64         /** NumChannels * BitsPerSample/8 */\r
  65         uint16_t block_align;\r
  66         /** 8 bits = 8, 16 bits = 16, etc. */\r
  67         uint16_t bits_per_sample;\r
  68         /** Contains the letters "data". */\r
  69         uint32_t subchunk2_id;\r
  70         /** Number of bytes in the data. */\r
  71         uint32_t subchunk2_size;\r
  72 };\r
  73 \r
  74 /*----------------------------------------------------------------------------\r
  75  *        Exported functions\r
  76  *----------------------------------------------------------------------------*/\r
  77 \r
  78 extern bool wav_is_valid(const struct _wav_header *header);\r
  79 \r
  80 extern void wav_display_info(const struct _wav_header *header);\r
  81 \r
  82 #endif /* #ifndef WAV_H */\r