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   return fseek(f,off,whence);
  54 }
  55
  56 /* These structs below (OV_CALLBACKS_DEFAULT etc)are defined here as static
  57  * data. That means that every file which includes this header will get its
  58  * own copy of these structs whether it uses them or not.
  59  *
  60  * It would be *much* better to move these the vorbisfile.c, make them
  61  * publicly available and then define them here as externs so that
  62  * only one copy of them (the one in the library's vorbisfile.c) is ever
  63  * created.
  64  *
  65  * Unfortunately this cannot be done at the moment because doing so would
  66  * break the libvorbisfile ABI. A good time to do that would be at some
  67  * other time when the ABI is being broken for some other reason. */
  68
  69 static ov_callbacks OV_CALLBACKS_DEFAULT = {
  70   (size_t (*)(void *, size_t, size_t, void *))  fread,
  71   (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
  72   (int (*)(void *))                             fclose,
  73   (long (*)(void *))                            ftell
  74 };
  75
  76 static ov_callbacks OV_CALLBACKS_NOCLOSE = {
  77   (size_t (*)(void *, size_t, size_t, void *))  fread,
  78   (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
  79   (int (*)(void *))                             NULL,
  80   (long (*)(void *))                            ftell
  81 };
  82
  83 static ov_callbacks OV_CALLBACKS_STREAMONLY = {
  84   (size_t (*)(void *, size_t, size_t, void *))  fread,
  85   (int (*)(void *, ogg_int64_t, int))           NULL,
  86   (int (*)(void *))                             fclose,
  87   (long (*)(void *))                            NULL
  88 };
  89
  90 static ov_callbacks OV_CALLBACKS_STREAMONLY_NOCLOSE = {
  91   (size_t (*)(void *, size_t, size_t, void *))  fread,
  92   (int (*)(void *, ogg_int64_t, int))           NULL,
  93   (int (*)(void *))                             NULL,
  94   (long (*)(void *))                            NULL
  95 };
  96
  97 #define  NOTOPEN   0
  98 #define  PARTOPEN  1
  99 #define  OPENED    2
 100 #define  STREAMSET 3
 101 #define  INITSET   4
 102
 103 typedef struct OggVorbis_File {
 104   void            *datasource; /* Pointer to a FILE *, etc. */
 105   int              seekable;
 106   ogg_int64_t      offset;
 107   ogg_int64_t      end;
 108   ogg_sync_state   oy;
 109
 110   /* If the FILE handle isn't seekable (eg, a pipe), only the current
 111      stream appears */
 112   int              links;
 113   ogg_int64_t     *offsets;
 114   ogg_int64_t     *dataoffsets;
 115   long            *serialnos;
 116   ogg_int64_t     *pcmlengths; /* overloaded to maintain binary
 117                                   compatability; x2 size, stores both
 118                                   beginning and end values */
 119   vorbis_info     *vi;
 120   vorbis_comment  *vc;
 121
 122   /* Decoding working state local storage */
 123   ogg_int64_t      pcm_offset;
 124   int              ready_state;
 125   long             current_serialno;
 126   int              current_link;
 127
 128   double           bittrack;
 129   double           samptrack;
 130
 131   ogg_stream_state os; /* take physical pages, weld into a logical
 132                           stream of packets */
 133   vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
 134   vorbis_block     vb; /* local working space for packet->PCM decode */
 135
 136   ov_callbacks callbacks;
 137
 138 } OggVorbis_File;
 139
 140
 141 extern int ov_clear(OggVorbis_File *vf);
 142 extern int ov_fopen(char *path,OggVorbis_File *vf);
 143 extern int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
 144 extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
 145                 char *initial, long ibytes, ov_callbacks callbacks);
 146
 147 extern int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
 148 extern int ov_test_callbacks(void *datasource, OggVorbis_File *vf,
 149                 char *initial, long ibytes, ov_callbacks callbacks);
 150 extern int ov_test_open(OggVorbis_File *vf);
 151
 152 extern long ov_bitrate(OggVorbis_File *vf,int i);
 153 extern long ov_bitrate_instant(OggVorbis_File *vf);
 154 extern long ov_streams(OggVorbis_File *vf);
 155 extern long ov_seekable(OggVorbis_File *vf);
 156 extern long ov_serialnumber(OggVorbis_File *vf,int i);
 157
 158 extern ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i);
 159 extern ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i);
 160 extern double ov_time_total(OggVorbis_File *vf,int i);
 161
 162 extern int ov_raw_seek(OggVorbis_File *vf,ogg_int64_t pos);
 163 extern int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos);
 164 extern int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
 165 extern int ov_time_seek(OggVorbis_File *vf,double pos);
 166 extern int ov_time_seek_page(OggVorbis_File *vf,double pos);
 167
 168 extern int ov_raw_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
 169 extern int ov_pcm_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
 170 extern int ov_pcm_seek_page_lap(OggVorbis_File *vf,ogg_int64_t pos);
 171 extern int ov_time_seek_lap(OggVorbis_File *vf,double pos);
 172 extern int ov_time_seek_page_lap(OggVorbis_File *vf,double pos);
 173
 174 extern ogg_int64_t ov_raw_tell(OggVorbis_File *vf);
 175 extern ogg_int64_t ov_pcm_tell(OggVorbis_File *vf);
 176 extern double ov_time_tell(OggVorbis_File *vf);
 177
 178 extern vorbis_info *ov_info(OggVorbis_File *vf,int link);
 179 extern vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
 180
 181 extern long ov_read_float(OggVorbis_File *vf,float ***pcm_channels,int samples,
 182                           int *bitstream);
 183 extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
 184                     int bigendianp,int word,int sgned,int *bitstream);
 185 extern int ov_crosslap(OggVorbis_File *vf1,OggVorbis_File *vf2);
 186
 187 extern int ov_halfrate(OggVorbis_File *vf,int flag);
 188 extern int ov_halfrate_p(OggVorbis_File *vf);
 189
 190 #ifdef __cplusplus
 191 }
 192 #endif /* __cplusplus */
 193
 194 #endif
 195
 196