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