herrie/src/audio_file.h

   1 /*
   2  * Copyright (c) 2006-2011 Ed Schouten <ed@80386.nl>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26 /**
  27  * @file audio_file.h
  28  * @brief Generic access and decoding of audio file formats.
  29  */
  30
  31 struct audio_format;
  32 struct vfsref;
  33
  34 /**
  35  * @brief The data needed about an audio file.
  36  */
  37 struct audio_file {
  38         /**
  39          * @brief The FILE pointer for the file.
  40          */
  41         FILE *fp;
  42
  43         /**
  44          * @brief An audio format for opening, closing and reading
  45          *      the audio file.
  46          */
  47         struct audio_format *drv;
  48         /**
  49          * @brief Extra information that might be needed.
  50          */
  51         void *drv_data;
  52
  53         /**
  54          * @brief The file's sample rate.
  55          */
  56         unsigned int srate;
  57
  58         /**
  59          * @brief The number of audio channels.
  60          */
  61         unsigned int channels;
  62
  63         /**
  64          * @brief The file's length in seconds.
  65          */
  66         unsigned int time_len;
  67         /**
  68          * @brief Position we are at in the file in seconds.
  69          */
  70         unsigned int time_cur;
  71         /**
  72          * @brief File is a stream (no seeking).
  73          */
  74         int stream;
  75
  76         /**
  77          * @brief Name of the artist, stored in UTF-8.
  78          */
  79         char *artist;
  80         /**
  81          * @brief Name of the song, stored in UTF-8.
  82          */
  83         char *title;
  84
  85 #ifdef BUILD_SCROBBLER
  86         /**
  87          * @brief Name of the album, stored in UTF-8.
  88          */
  89         char *album;
  90         /**
  91          * @brief Indicator whether the scrobbler code is done with the
  92          *        song.
  93          */
  94         char _scrobbler_done;
  95 #endif /* BUILD_SCROBBLER */
  96 };
  97
  98 /**
  99  * @brief Fill an audio_file struct with the appropiate information
 100  *        and function calls, and open the file handle.
 101  */
 102 struct audio_file *audio_file_open(const struct vfsref *vr);
 103 /**
 104  * @brief Clean up the given audio_file struct and close the file handle.
 105  */
 106 void audio_file_close(struct audio_file *fd);
 107
 108 /**
 109  * @brief Call the read function in the audio_file struct.
 110  */
 111 size_t audio_file_read(struct audio_file *fd, int16_t *buf, size_t len);
 112
 113 /**
 114  * @brief Call the seek function in the audio_file struct.
 115  */
 116 void audio_file_seek(struct audio_file *fd, int len, int rel);