include/vorbis/vorbisfile.h

   1 /********************************************************************
   2  *                                                                  *
   3  * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
   4  * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
   5  * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
   6  * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
   7  *                                                                  *
   8  * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007             *
   9  * by the Xiph.Org Foundation http://www.xiph.org/                  *
  10  *                                                                  *
  11  ********************************************************************
  12
  13  function: stdio-based convenience library for opening/seeking/decoding
  14  last mod: $Id$
  15
  16  ********************************************************************/
  17
  18 #ifndef _OV_FILE_H_
  19 #define _OV_FILE_H_
  20
  21 #ifdef __cplusplus
  22 extern "C"
  23 {
  24 #endif /* __cplusplus */
  25
  26 #include <stdio.h>
  27 #include "codec.h"
  28
  29 /* The function prototypes for the callbacks are basically the same as for
  30  * the stdio functions fread, fseek, fclose, ftell.
  31  * The one difference is that the FILE * arguments have been replaced with
  32  * a void * - this is to be used as a pointer to whatever internal data these
  33  * functions might need. In the stdio case, it's just a FILE * cast to a void *
  34  *
  35  * If you use other functions, check the docs for these functions and return
  36  * the right values. For seek_func(), you *MUST* return -1 if the stream is
  37  * unseekable
  38  */
  39 typedef struct {
  40   size_t (*read_func)  (void *ptr, size_t size, size_t nmemb, void *datasource);
  41   int    (*seek_func)  (void *datasource, ogg_int64_t offset, int whence);
  42   int    (*close_func) (void *datasource);
  43   long   (*tell_func)  (void *datasource);
  44 } ov_callbacks;
  45
  46 /* a few sets of convenient callbacks, especially for use under
  47  * Windows where ov_open_callbacks() should always be used instead of
  48  * ov_open() to avoid problems with incompatable crt.o version linking
  49  * issues. */
  50
  51 static int _ov_header_fseek_wrap(FILE *f,ogg_int64_t off,int whence){
  52   if(f==NULL)return(-1);
  53
  54 #ifdef __MINGW32__
  55   return fseeko64(f,off,whence);
  56 #elif defined (_WIN32)
  57   return _fseeki64(f,off,whence);
  58 #else
  59   return fseek(f,off,whence);
  60 #endif
  61 }
  62
  63 /* These structs below (OV_CALLBACKS_DEFAULT etc) are defined here as
  64  * static data. That means that every file which includes this header
  65  * will get its own copy of these structs whether it uses them or
  66  * not. This is essential on platforms such as Windows on which
  67  * several different versions of stdio support may be linked to by
  68  * different DLLs, and we need to be certain we know which one we're
  69  * using (the same one as the main application).
  70  */
  71
  72 static ov_callbacks OV_CALLBACKS_DEFAULT = {
  73   (size_t (*)(void *, size_t, size_t, void *))  fread,
  74   (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
  75   (int (*)(void *))                             fclose,
  76   (long (*)(void *))                            ftell
  77 };
  78
  79 static ov_callbacks OV_CALLBACKS_NOCLOSE = {
  80   (size_t (*)(void *, size_t, size_t, void *))  fread,
  81   (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
  82   (int (*)(void *))                             NULL,
  83   (long (*)(void *))                            ftell
  84 };
  85
  86 static ov_callbacks OV_CALLBACKS_STREAMONLY = {
  87   (size_t (*)(void *, size_t, size_t, void *))  fread,
  88   (int (*)(void *, ogg_int64_t, int))           NULL,
  89   (int (*)(void *))                             fclose,
  90   (long (*)(void *))                            NULL
  91 };
  92
  93 static ov_callbacks OV_CALLBACKS_STREAMONLY_NOCLOSE = {
  94   (size_t (*)(void *, size_t, size_t, void *))  fread,
  95   (int (*)(void *, ogg_int64_t, int))           NULL,
  96   (int (*)(void *))                             NULL,
  97   (long (*)(void *))                            NULL
  98 };
  99
 100 #define  NOTOPEN   0
 101 #define  PARTOPEN  1
 102 #define  OPENED    2
 103 #define  STREAMSET 3
 104 #define  INITSET   4
 105
 106 typedef struct OggVorbis_File {
 107   void            *datasource; /* Pointer to a FILE *, etc. */
 108   int              seekable;
 109   ogg_int64_t      offset;
 110   ogg_int64_t      end;
 111   ogg_sync_state   oy;
 112
 113   /* If the FILE handle isn't seekable (eg, a pipe), only the current
 114      stream appears */
 115   int              links;
 116   ogg_int64_t     *offsets;
 117   ogg_int64_t     *dataoffsets;
 118   long            *serialnos;
 119   ogg_int64_t     *pcmlengths; /* overloaded to maintain binary
 120                                   compatability; x2 size, stores both
 121                                   beginning and end values */
 122   vorbis_info     *vi;
 123   vorbis_comment  *vc;
 124
 125   /* Decoding working state local storage */
 126   ogg_int64_t      pcm_offset;
 127   int              ready_state;
 128   long             current_serialno;
 129   int              current_link;
 130
 131   double           bittrack;
 132   double           samptrack;
 133
 134   ogg_stream_state os; /* take physical pages, weld into a logical
 135                           stream of packets */
 136   vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
 137   vorbis_block     vb; /* local working space for packet->PCM decode */
 138
 139   ov_callbacks callbacks;
 140
 141 } OggVorbis_File;
 142
 143
 144 extern int ov_clear(OggVorbis_File *vf);
 145 extern int ov_fopen(char *path,OggVorbis_File *vf);
 146 extern int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
 147 extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
 148                 char *initial, long ibytes, ov_callbacks callbacks);
 149
 150 extern int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
 151 extern int ov_test_callbacks(void *datasource, OggVorbis_File *vf,
 152                 char *initial, long ibytes, ov_callbacks callbacks);
 153 extern int ov_test_open(OggVorbis_File *vf);
 154
 155 extern long ov_bitrate(OggVorbis_File *vf,int i);
 156 extern long ov_bitrate_instant(OggVorbis_File *vf);
 157 extern long ov_streams(OggVorbis_File *vf);
 158 extern long ov_seekable(OggVorbis_File *vf);
 159 extern long ov_serialnumber(OggVorbis_File *vf,int i);
 160
 161 extern ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i);
 162 extern ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i);
 163 extern double ov_time_total(OggVorbis_File *vf,int i);
 164
 165 extern int ov_raw_seek(OggVorbis_File *vf,ogg_int64_t pos);
 166 extern int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos);
 167 extern int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
 168 extern int ov_time_seek(OggVorbis_File *vf,double pos);
 169 extern int ov_time_seek_page(OggVorbis_File *vf,double pos);
 170
 171 extern int ov_raw_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
 172 extern int ov_pcm_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
 173 extern int ov_pcm_seek_page_lap(OggVorbis_File *vf,ogg_int64_t pos);
 174 extern int ov_time_seek_lap(OggVorbis_File *vf,double pos);
 175 extern int ov_time_seek_page_lap(OggVorbis_File *vf,double pos);
 176
 177 extern ogg_int64_t ov_raw_tell(OggVorbis_File *vf);
 178 extern ogg_int64_t ov_pcm_tell(OggVorbis_File *vf);
 179 extern double ov_time_tell(OggVorbis_File *vf);
 180
 181 extern vorbis_info *ov_info(OggVorbis_File *vf,int link);
 182 extern vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
 183
 184 extern long ov_read_float(OggVorbis_File *vf,float ***pcm_channels,int samples,
 185                           int *bitstream);
 186 extern long ov_read_filter(OggVorbis_File *vf,char *buffer,int length,
 187                           int bigendianp,int word,int sgned,int *bitstream,
 188                           void (*filter)(float **pcm,long channels,long samples,void *filter_param),void *filter_param);
 189 extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
 190                     int bigendianp,int word,int sgned,int *bitstream);
 191 extern int ov_crosslap(OggVorbis_File *vf1,OggVorbis_File *vf2);
 192
 193 extern int ov_halfrate(OggVorbis_File *vf,int flag);
 194 extern int ov_halfrate_p(OggVorbis_File *vf);
 195
 196 #ifdef __cplusplus
 197 }
 198 #endif /* __cplusplus */
 199
 200 #endif
 201