Chris@34: /******************************************************************** Chris@34: * * Chris@34: * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. * Chris@34: * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS * Chris@34: * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE * Chris@34: * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. * Chris@34: * * Chris@34: * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 * Chris@34: * by the Xiph.Org Foundation http://www.xiph.org/ * Chris@34: Chris@34: ******************************************************************** Chris@34: Chris@34: function: libvorbis codec headers Chris@34: last mod: $Id: codec.h 17021 2010-03-24 09:29:41Z xiphmont $ Chris@34: Chris@34: ********************************************************************/ Chris@34: Chris@34: #ifndef _vorbis_codec_h_ Chris@34: #define _vorbis_codec_h_ Chris@34: Chris@34: #ifdef __cplusplus Chris@34: extern "C" Chris@34: { Chris@34: #endif /* __cplusplus */ Chris@34: Chris@34: #include Chris@34: Chris@34: typedef struct vorbis_info{ Chris@34: int version; Chris@34: int channels; Chris@34: long rate; Chris@34: Chris@34: /* The below bitrate declarations are *hints*. Chris@34: Combinations of the three values carry the following implications: Chris@34: Chris@34: all three set to the same value: Chris@34: implies a fixed rate bitstream Chris@34: only nominal set: Chris@34: implies a VBR stream that averages the nominal bitrate. No hard Chris@34: upper/lower limit Chris@34: upper and or lower set: Chris@34: implies a VBR bitstream that obeys the bitrate limits. nominal Chris@34: may also be set to give a nominal rate. Chris@34: none set: Chris@34: the coder does not care to speculate. Chris@34: */ Chris@34: Chris@34: long bitrate_upper; Chris@34: long bitrate_nominal; Chris@34: long bitrate_lower; Chris@34: long bitrate_window; Chris@34: Chris@34: void *codec_setup; Chris@34: } vorbis_info; Chris@34: Chris@34: /* vorbis_dsp_state buffers the current vorbis audio Chris@34: analysis/synthesis state. The DSP state belongs to a specific Chris@34: logical bitstream ****************************************************/ Chris@34: typedef struct vorbis_dsp_state{ Chris@34: int analysisp; Chris@34: vorbis_info *vi; Chris@34: Chris@34: float **pcm; Chris@34: float **pcmret; Chris@34: int pcm_storage; Chris@34: int pcm_current; Chris@34: int pcm_returned; Chris@34: Chris@34: int preextrapolate; Chris@34: int eofflag; Chris@34: Chris@34: long lW; Chris@34: long W; Chris@34: long nW; Chris@34: long centerW; Chris@34: Chris@34: ogg_int64_t granulepos; Chris@34: ogg_int64_t sequence; Chris@34: Chris@34: ogg_int64_t glue_bits; Chris@34: ogg_int64_t time_bits; Chris@34: ogg_int64_t floor_bits; Chris@34: ogg_int64_t res_bits; Chris@34: Chris@34: void *backend_state; Chris@34: } vorbis_dsp_state; Chris@34: Chris@34: typedef struct vorbis_block{ Chris@34: /* necessary stream state for linking to the framing abstraction */ Chris@34: float **pcm; /* this is a pointer into local storage */ Chris@34: oggpack_buffer opb; Chris@34: Chris@34: long lW; Chris@34: long W; Chris@34: long nW; Chris@34: int pcmend; Chris@34: int mode; Chris@34: Chris@34: int eofflag; Chris@34: ogg_int64_t granulepos; Chris@34: ogg_int64_t sequence; Chris@34: vorbis_dsp_state *vd; /* For read-only access of configuration */ Chris@34: Chris@34: /* local storage to avoid remallocing; it's up to the mapping to Chris@34: structure it */ Chris@34: void *localstore; Chris@34: long localtop; Chris@34: long localalloc; Chris@34: long totaluse; Chris@34: struct alloc_chain *reap; Chris@34: Chris@34: /* bitmetrics for the frame */ Chris@34: long glue_bits; Chris@34: long time_bits; Chris@34: long floor_bits; Chris@34: long res_bits; Chris@34: Chris@34: void *internal; Chris@34: Chris@34: } vorbis_block; Chris@34: Chris@34: /* vorbis_block is a single block of data to be processed as part of Chris@34: the analysis/synthesis stream; it belongs to a specific logical Chris@34: bitstream, but is independent from other vorbis_blocks belonging to Chris@34: that logical bitstream. *************************************************/ Chris@34: Chris@34: struct alloc_chain{ Chris@34: void *ptr; Chris@34: struct alloc_chain *next; Chris@34: }; Chris@34: Chris@34: /* vorbis_info contains all the setup information specific to the Chris@34: specific compression/decompression mode in progress (eg, Chris@34: psychoacoustic settings, channel setup, options, codebook Chris@34: etc). vorbis_info and substructures are in backends.h. Chris@34: *********************************************************************/ Chris@34: Chris@34: /* the comments are not part of vorbis_info so that vorbis_info can be Chris@34: static storage */ Chris@34: typedef struct vorbis_comment{ Chris@34: /* unlimited user comment fields. libvorbis writes 'libvorbis' Chris@34: whatever vendor is set to in encode */ Chris@34: char **user_comments; Chris@34: int *comment_lengths; Chris@34: int comments; Chris@34: char *vendor; Chris@34: Chris@34: } vorbis_comment; Chris@34: Chris@34: Chris@34: /* libvorbis encodes in two abstraction layers; first we perform DSP Chris@34: and produce a packet (see docs/analysis.txt). The packet is then Chris@34: coded into a framed OggSquish bitstream by the second layer (see Chris@34: docs/framing.txt). Decode is the reverse process; we sync/frame Chris@34: the bitstream and extract individual packets, then decode the Chris@34: packet back into PCM audio. Chris@34: Chris@34: The extra framing/packetizing is used in streaming formats, such as Chris@34: files. Over the net (such as with UDP), the framing and Chris@34: packetization aren't necessary as they're provided by the transport Chris@34: and the streaming layer is not used */ Chris@34: Chris@34: /* Vorbis PRIMITIVES: general ***************************************/ Chris@34: Chris@34: extern void vorbis_info_init(vorbis_info *vi); Chris@34: extern void vorbis_info_clear(vorbis_info *vi); Chris@34: extern int vorbis_info_blocksize(vorbis_info *vi,int zo); Chris@34: extern void vorbis_comment_init(vorbis_comment *vc); Chris@34: extern void vorbis_comment_add(vorbis_comment *vc, const char *comment); Chris@34: extern void vorbis_comment_add_tag(vorbis_comment *vc, Chris@34: const char *tag, const char *contents); Chris@34: extern char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count); Chris@34: extern int vorbis_comment_query_count(vorbis_comment *vc, const char *tag); Chris@34: extern void vorbis_comment_clear(vorbis_comment *vc); Chris@34: Chris@34: extern int vorbis_block_init(vorbis_dsp_state *v, vorbis_block *vb); Chris@34: extern int vorbis_block_clear(vorbis_block *vb); Chris@34: extern void vorbis_dsp_clear(vorbis_dsp_state *v); Chris@34: extern double vorbis_granule_time(vorbis_dsp_state *v, Chris@34: ogg_int64_t granulepos); Chris@34: Chris@34: extern const char *vorbis_version_string(void); Chris@34: Chris@34: /* Vorbis PRIMITIVES: analysis/DSP layer ****************************/ Chris@34: Chris@34: extern int vorbis_analysis_init(vorbis_dsp_state *v,vorbis_info *vi); Chris@34: extern int vorbis_commentheader_out(vorbis_comment *vc, ogg_packet *op); Chris@34: extern int vorbis_analysis_headerout(vorbis_dsp_state *v, Chris@34: vorbis_comment *vc, Chris@34: ogg_packet *op, Chris@34: ogg_packet *op_comm, Chris@34: ogg_packet *op_code); Chris@34: extern float **vorbis_analysis_buffer(vorbis_dsp_state *v,int vals); Chris@34: extern int vorbis_analysis_wrote(vorbis_dsp_state *v,int vals); Chris@34: extern int vorbis_analysis_blockout(vorbis_dsp_state *v,vorbis_block *vb); Chris@34: extern int vorbis_analysis(vorbis_block *vb,ogg_packet *op); Chris@34: Chris@34: extern int vorbis_bitrate_addblock(vorbis_block *vb); Chris@34: extern int vorbis_bitrate_flushpacket(vorbis_dsp_state *vd, Chris@34: ogg_packet *op); Chris@34: Chris@34: /* Vorbis PRIMITIVES: synthesis layer *******************************/ Chris@34: extern int vorbis_synthesis_idheader(ogg_packet *op); Chris@34: extern int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc, Chris@34: ogg_packet *op); Chris@34: Chris@34: extern int vorbis_synthesis_init(vorbis_dsp_state *v,vorbis_info *vi); Chris@34: extern int vorbis_synthesis_restart(vorbis_dsp_state *v); Chris@34: extern int vorbis_synthesis(vorbis_block *vb,ogg_packet *op); Chris@34: extern int vorbis_synthesis_trackonly(vorbis_block *vb,ogg_packet *op); Chris@34: extern int vorbis_synthesis_blockin(vorbis_dsp_state *v,vorbis_block *vb); Chris@34: extern int vorbis_synthesis_pcmout(vorbis_dsp_state *v,float ***pcm); Chris@34: extern int vorbis_synthesis_lapout(vorbis_dsp_state *v,float ***pcm); Chris@34: extern int vorbis_synthesis_read(vorbis_dsp_state *v,int samples); Chris@34: extern long vorbis_packet_blocksize(vorbis_info *vi,ogg_packet *op); Chris@34: Chris@34: extern int vorbis_synthesis_halfrate(vorbis_info *v,int flag); Chris@34: extern int vorbis_synthesis_halfrate_p(vorbis_info *v); Chris@34: Chris@34: /* Vorbis ERRORS and return codes ***********************************/ Chris@34: Chris@34: #define OV_FALSE -1 Chris@34: #define OV_EOF -2 Chris@34: #define OV_HOLE -3 Chris@34: Chris@34: #define OV_EREAD -128 Chris@34: #define OV_EFAULT -129 Chris@34: #define OV_EIMPL -130 Chris@34: #define OV_EINVAL -131 Chris@34: #define OV_ENOTVORBIS -132 Chris@34: #define OV_EBADHEADER -133 Chris@34: #define OV_EVERSION -134 Chris@34: #define OV_ENOTAUDIO -135 Chris@34: #define OV_EBADPACKET -136 Chris@34: #define OV_EBADLINK -137 Chris@34: #define OV_ENOSEEK -138 Chris@34: Chris@34: #ifdef __cplusplus Chris@34: } Chris@34: #endif /* __cplusplus */ Chris@34: Chris@34: #endif Chris@34: