openshot-audio  0.1.7
codebook.h
Go to the documentation of this file.
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-2009 *
9  * by the Xiph.Org Foundation http://www.xiph.org/ *
10  * *
11  ********************************************************************
12 
13  function: basic shared codebook operations
14  last mod: $Id: codebook.h 17030 2010-03-25 06:52:55Z xiphmont $
15 
16  ********************************************************************/
17 
18 #ifndef _V_CODEBOOK_H_
19 #define _V_CODEBOOK_H_
20 
21 #include "../../ogg.h"
22 
23 /* This structure encapsulates huffman and VQ style encoding books; it
24  doesn't do anything specific to either.
25 
26  valuelist/quantlist are nonNULL (and q_* significant) only if
27  there's entry->value mapping to be done.
28 
29  If encode-side mapping must be done (and thus the entry needs to be
30  hunted), the auxiliary encode pointer will point to a decision
31  tree. This is true of both VQ and huffman, but is mostly useful
32  with VQ.
33 
34 */
35 
36 typedef struct static_codebook{
37  long dim; /* codebook dimensions (elements per vector) */
38  long entries; /* codebook entries */
39  long *lengthlist; /* codeword lengths in bits */
40 
41  /* mapping ***************************************************************/
42  int maptype; /* 0=none
43  1=implicitly populated values from map column
44  2=listed arbitrary values */
45 
46  /* The below does a linear, single monotonic sequence mapping. */
47  long q_min; /* packed 32 bit float; quant value 0 maps to minval */
48  long q_delta; /* packed 32 bit float; val 1 - val 0 == delta */
49  int q_quant; /* bits: 0 < quant <= 16 */
50  int q_sequencep; /* bitflag */
51 
52  long *quantlist; /* map == 1: (int)(entries^(1/dim)) element column map
53  map == 2: list of dim*entries quantized entry vals
54  */
55  int allocedp;
57 
58 typedef struct codebook{
59  long dim; /* codebook dimensions (elements per vector) */
60  long entries; /* codebook entries */
61  long used_entries; /* populated codebook entries */
63 
64  /* for encode, the below are entry-ordered, fully populated */
65  /* for decode, the below are ordered by bitreversed codeword and only
66  used entries are populated */
67  float *valuelist; /* list of dim*entries actual entry values */
68  ogg_uint32_t *codelist; /* list of bitstream codewords for each entry */
69 
70  int *dec_index; /* only used if sparseness collapsed */
75 
76  /* The current encoder uses only centered, integer-only lattice books. */
77  int quantvals;
78  int minval;
79  int delta;
80 } codebook;
81 
83 extern int vorbis_book_init_encode(codebook *dest,const static_codebook *source);
84 extern int vorbis_book_init_decode(codebook *dest,const static_codebook *source);
85 extern void vorbis_book_clear(codebook *b);
86 
87 extern float *_book_unquantize(const static_codebook *b,int n,int *map);
88 extern float *_book_logdist(const static_codebook *b,float *vals);
89 extern float _float32_unpack(long val);
90 extern long _float32_pack(float val);
91 extern int _best(codebook *book, float *a, int step);
92 extern int _ilog(unsigned int v);
93 extern long _book_maptype1_quantvals(const static_codebook *b);
94 
95 extern int vorbis_book_besterror(codebook *book,float *a,int step,int addmul);
96 extern long vorbis_book_codeword(codebook *book,int entry);
97 extern long vorbis_book_codelen(codebook *book,int entry);
98 
99 
100 
103 
104 extern int vorbis_book_encode(codebook *book, int a, oggpack_buffer *b);
105 
106 extern long vorbis_book_decode(codebook *book, oggpack_buffer *b);
107 extern long vorbis_book_decodevs_add(codebook *book, float *a,
108  oggpack_buffer *b,int n);
109 extern long vorbis_book_decodev_set(codebook *book, float *a,
110  oggpack_buffer *b,int n);
111 extern long vorbis_book_decodev_add(codebook *book, float *a,
112  oggpack_buffer *b,int n);
113 extern long vorbis_book_decodevv_add(codebook *book, float **a,
114  long off,int ch,
115  oggpack_buffer *b,int n);
116 
117 
118 
119 #endif
int vorbis_book_encode(codebook *book, int a, oggpack_buffer *b)
Definition: codebook.c:274
long vorbis_book_codeword(codebook *book, int entry)
Definition: sharedbook.c:432
long vorbis_book_decodevs_add(codebook *book, float *a, oggpack_buffer *b, int n)
Definition: codebook.c:370
long dim
Definition: codebook.h:59
Definition: codebook.h:36
int * dec_index
Definition: codebook.h:70
long dim
Definition: codebook.h:37
long vorbis_book_decodevv_add(codebook *book, float **a, long off, int ch, oggpack_buffer *b, int n)
Definition: codebook.c:457
void vorbis_staticbook_destroy(static_codebook *b)
Definition: sharedbook.c:261
const static_codebook * c
Definition: codebook.h:62
long vorbis_book_decode(codebook *book, oggpack_buffer *b)
Definition: codebook.c:358
long vorbis_book_codelen(codebook *book, int entry)
Definition: sharedbook.c:439
ogg_uint32_t * codelist
Definition: codebook.h:68
int q_sequencep
Definition: codebook.h:50
long b
Definition: jpegint.h:371
int vorbis_book_init_decode(codebook *dest, const static_codebook *source)
Definition: sharedbook.c:315
ogg_uint32_t * dec_firsttable
Definition: codebook.h:72
long used_entries
Definition: codebook.h:61
float * _book_unquantize(const static_codebook *b, int n, int *map)
Definition: sharedbook.c:196
void vorbis_book_clear(codebook *b)
Definition: sharedbook.c:270
float _float32_unpack(long val)
Definition: sharedbook.c:62
int vorbis_book_besterror(codebook *book, float *a, int step, int addmul)
int q_quant
Definition: codebook.h:49
long * quantlist
Definition: codebook.h:52
int _best(codebook *book, float *a, int step)
Definition: codebook.h:58
int val
Definition: jpeglib.h:956
long entries
Definition: codebook.h:38
long _float32_pack(float val)
Definition: sharedbook.c:47
Definition: ogg.h:26
int _ilog(unsigned int v)
Definition: sharedbook.c:29
static_codebook * vorbis_staticbook_unpack(oggpack_buffer *b)
Definition: codebook.c:149
struct codebook codebook
unsigned int ogg_uint32_t
Definition: config_types.h:7
int maptype
Definition: codebook.h:42
long vorbis_book_decodev_add(codebook *book, float *a, oggpack_buffer *b, int n)
Definition: codebook.c:389
int vorbis_book_init_encode(codebook *dest, const static_codebook *source)
Definition: sharedbook.c:283
int dec_maxlength
Definition: codebook.h:74
int delta
Definition: codebook.h:79
float * _book_logdist(const static_codebook *b, float *vals)
long q_delta
Definition: codebook.h:48
long _book_maptype1_quantvals(const static_codebook *b)
Definition: sharedbook.c:163
int vorbis_staticbook_pack(const static_codebook *c, oggpack_buffer *b)
Definition: codebook.c:30
struct static_codebook static_codebook
long vorbis_book_decodev_set(codebook *book, float *a, oggpack_buffer *b, int n)
Definition: codebook.c:434
long q_min
Definition: codebook.h:47
float * valuelist
Definition: codebook.h:67
long * lengthlist
Definition: codebook.h:39
int allocedp
Definition: codebook.h:55
char * dec_codelengths
Definition: codebook.h:71
int quantvals
Definition: codebook.h:77
int minval
Definition: codebook.h:78
long entries
Definition: codebook.h:60
int dec_firsttablen
Definition: codebook.h:73