apps/codecs/libtremor/ivorbiscodec.h

   1 /********************************************************************
   2  *                                                                  *
   3  * THIS FILE IS PART OF THE OggVorbis 'TREMOR' CODEC SOURCE CODE.   *
   4  *                                                                  *
   5  * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
   6  * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
   7  * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
   8  *                                                                  *
   9  * THE OggVorbis 'TREMOR' SOURCE CODE IS (C) COPYRIGHT 1994-2002    *
  10  * BY THE Xiph.Org FOUNDATION http://www.xiph.org/                  *
  11  *                                                                  *
  12  ********************************************************************
  13
  14  function: libvorbis codec headers
  15
  16  ********************************************************************/
  17
  18 #ifndef _vorbis_codec_h_
  19 #define _vorbis_codec_h_
  20
  21 #ifdef __cplusplus
  22 extern "C"
  23 {
  24 #endif /* __cplusplus */
  25
  26 #include "ogg.h"
  27
  28 typedef struct vorbis_info{
  29   int version;
  30   int channels;
  31   long rate;
  32
  33   /* The below bitrate declarations are *hints*.
  34      Combinations of the three values carry the following implications:
  35
  36      all three set to the same value:
  37        implies a fixed rate bitstream
  38      only nominal set:
  39        implies a VBR stream that averages the nominal bitrate.  No hard
  40        upper/lower limit
  41      upper and or lower set:
  42        implies a VBR bitstream that obeys the bitrate limits. nominal
  43        may also be set to give a nominal rate.
  44      none set:
  45        the coder does not care to speculate.
  46   */
  47
  48   long bitrate_upper;
  49   long bitrate_nominal;
  50   long bitrate_lower;
  51
  52   void *codec_setup;
  53 } vorbis_info;
  54
  55 /* vorbis_dsp_state buffers the current vorbis audio
  56    analysis/synthesis state.  The DSP state belongs to a specific
  57    logical bitstream ****************************************************/
  58 typedef struct vorbis_dsp_state{
  59   vorbis_info *vi;
  60
  61   ogg_int32_t **pcm;
  62   ogg_int32_t **pcmb;
  63   ogg_int32_t **pcmret;
  64   int      pcm_storage;
  65   int      pcm_current;
  66   int      pcm_returned;
  67
  68   int  eofflag;
  69
  70   long lW;
  71   long W;
  72   long nW;
  73   long centerW;
  74
  75   ogg_int64_t granulepos;
  76   ogg_int64_t sequence;
  77
  78   void       *backend_state;
  79
  80   ogg_int32_t *iram_pcm;        /* IRAM PCM buffer */
  81   ogg_int32_t *iram_double_pcm; /* IRAM PCM 2nd buffer */
  82   int iram_pcm_storage;         /* size of IRAM PCM buffer */
  83   bool reset_pcmb;
  84 } vorbis_dsp_state;
  85
  86 typedef struct vorbis_block{
  87   /* necessary stream state for linking to the framing abstraction */
  88   ogg_int32_t  **pcm;       /* this is a pointer into local storage */
  89   oggpack_buffer opb;
  90
  91   long  lW;
  92   long  W;
  93   long  nW;
  94   int   pcmend;
  95   int   mode;
  96
  97   int         eofflag;
  98   ogg_int64_t granulepos;
  99   ogg_int64_t sequence;
 100   vorbis_dsp_state *vd; /* For read-only access of configuration */
 101
 102   /* local storage to avoid remallocing; it's up to the mapping to
 103      structure it */
 104   void               *localstore;
 105   long                localtop;
 106   long                localalloc;
 107   long                totaluse;
 108   struct alloc_chain *reap;
 109
 110 } vorbis_block;
 111
 112 /* vorbis_block is a single block of data to be processed as part of
 113 the analysis/synthesis stream; it belongs to a specific logical
 114 bitstream, but is independant from other vorbis_blocks belonging to
 115 that logical bitstream. *************************************************/
 116
 117 struct alloc_chain{
 118   void *ptr;
 119   struct alloc_chain *next;
 120 };
 121
 122 /* vorbis_info contains all the setup information specific to the
 123    specific compression/decompression mode in progress (eg,
 124    psychoacoustic settings, channel setup, options, codebook
 125    etc). vorbis_info and substructures are in backends.h.
 126 *********************************************************************/
 127
 128 /* the comments are not part of vorbis_info so that vorbis_info can be
 129    static storage */
 130 typedef struct vorbis_comment{
 131   /* unlimited user comment fields.  libvorbis writes 'libvorbis'
 132      whatever vendor is set to in encode */
 133   char **user_comments;
 134   int   *comment_lengths;
 135   int    comments;
 136   char  *vendor;
 137
 138 } vorbis_comment;
 139
 140
 141 /* libvorbis encodes in two abstraction layers; first we perform DSP
 142    and produce a packet (see docs/analysis.txt).  The packet is then
 143    coded into a framed OggSquish bitstream by the second layer (see
 144    docs/framing.txt).  Decode is the reverse process; we sync/frame
 145    the bitstream and extract individual packets, then decode the
 146    packet back into PCM audio.
 147
 148    The extra framing/packetizing is used in streaming formats, such as
 149    files.  Over the net (such as with UDP), the framing and
 150    packetization aren't necessary as they're provided by the transport
 151    and the streaming layer is not used */
 152
 153 /* Vorbis PRIMITIVES: general ***************************************/
 154
 155 extern void     vorbis_info_init(vorbis_info *vi);
 156 extern void     vorbis_info_clear(vorbis_info *vi);
 157 extern int      vorbis_info_blocksize(vorbis_info *vi,int zo);
 158 extern void     vorbis_comment_init(vorbis_comment *vc);
 159 extern void     vorbis_comment_add(vorbis_comment *vc, char *comment);
 160 extern void     vorbis_comment_add_tag(vorbis_comment *vc,
 161                                        char *tag, char *contents);
 162 extern void     vorbis_comment_clear(vorbis_comment *vc);
 163
 164 extern int      vorbis_block_init(vorbis_dsp_state *v, vorbis_block *vb);
 165 extern int      vorbis_block_clear(vorbis_block *vb);
 166 extern void     vorbis_dsp_clear(vorbis_dsp_state *v);
 167
 168 /* Vorbis PRIMITIVES: synthesis layer *******************************/
 169 extern int      vorbis_synthesis_idheader(ogg_packet *op);
 170 extern int      vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
 171                                           ogg_packet *op);
 172
 173 extern int      vorbis_synthesis_init(vorbis_dsp_state *v,vorbis_info *vi);
 174 extern int      vorbis_synthesis_restart(vorbis_dsp_state *v);
 175 extern int      vorbis_synthesis(vorbis_block *vb,ogg_packet *op,int decodep);
 176 extern int      vorbis_synthesis_blockin(vorbis_dsp_state *v,vorbis_block *vb);
 177 extern int      vorbis_synthesis_pcmout(vorbis_dsp_state *v,ogg_int32_t ***pcm);
 178 extern int      vorbis_synthesis_read(vorbis_dsp_state *v,int samples);
 179 extern long     vorbis_packet_blocksize(vorbis_info *vi,ogg_packet *op);
 180
 181 /* Vorbis ERRORS and return codes ***********************************/
 182
 183 #define OV_FALSE      -1
 184 #define OV_EOF        -2
 185 #define OV_HOLE       -3
 186
 187 #define OV_EREAD      -128
 188 #define OV_EFAULT     -129
 189 #define OV_EIMPL      -130
 190 #define OV_EINVAL     -131
 191 #define OV_ENOTVORBIS -132
 192 #define OV_EBADHEADER -133
 193 #define OV_EVERSION   -134
 194 #define OV_ENOTAUDIO  -135
 195 #define OV_EBADPACKET -136
 196 #define OV_EBADLINK   -137
 197 #define OV_ENOSEEK    -138
 198
 199 #ifdef __cplusplus
 200 }
 201 #endif /* __cplusplus */
 202
 203 #endif
 204