1 /********************************************************************
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. *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
9 * by the XIPHOPHORUS Company http://www.xiph.org/ *
11 ********************************************************************
13 function: basic shared codebook operations
14 last mod: $Id: sharedbook.c,v 1.28 2002/06/28 22:19:37 xiphmont Exp $
16 ********************************************************************/
24 #include "vorbis/codec.h"
28 /**** pack/unpack helpers ******************************************/
29 int _ilog(unsigned int v){
38 /* 32 bit float (not IEEE; nonnormalized mantissa +
39 biased exponent) : neeeeeee eeemmmmm mmmmmmmm mmmmmmmm
40 Why not IEEE? It's just not that important here. */
44 #define VQ_FEXP_BIAS 768 /* bias toward values smaller than 1. */
46 /* doesn't currently guard under/overflow */
47 long _float32_pack(float val){
55 exp= floor(log(val)/log(2.f));
56 mant=rint(ldexp(val,(VQ_FMAN-1)-exp));
57 exp=(exp+VQ_FEXP_BIAS)<<VQ_FMAN;
59 return(sign|exp|mant);
62 float _float32_unpack(long val){
63 double mant=val&0x1fffff;
64 int sign=val&0x80000000;
65 long exp =(val&0x7fe00000L)>>VQ_FMAN;
67 return(ldexp(mant,exp-(VQ_FMAN-1)-VQ_FEXP_BIAS));
70 /* given a list of word lengths, generate a list of codewords. Works
71 for length ordered or unordered, always assigns the lowest valued
72 codewords first. Extended to handle unused entries (length 0) */
73 ogg_uint32_t *_make_words(long *l,long n,long sparsecount){
75 ogg_uint32_t marker[33];
76 ogg_uint32_t *r=_ogg_malloc((sparsecount?sparsecount:n)*sizeof(*r));
77 memset(marker,0,sizeof(marker));
82 ogg_uint32_t entry=marker[length];
84 /* when we claim a node for an entry, we also claim the nodes
85 below it (pruning off the imagined tree that may have dangled
86 from it) as well as blocking the use of any nodes directly
90 if(length<32 && (entry>>length)){
91 /* error condition; the lengths must specify an overpopulated tree */
97 /* Look to see if the next shorter marker points to the node
98 above. if so, update it and repeat. */
100 for(j=length;j>0;j--){
103 /* have to jump branches */
107 marker[j]=marker[j-1]<<1;
108 break; /* invariant says next upper marker would already
109 have been moved if it was on the same path */
115 /* prune the tree; the implicit invariant says all the longer
116 markers were dangling from our just-taken node. Dangle them
117 from our *new* node. */
118 for(j=length+1;j<33;j++)
119 if((marker[j]>>1) == entry){
121 marker[j]=marker[j-1]<<1;
125 if(sparsecount==0)count++;
128 /* bitreverse the words because our bitwise packer/unpacker is LSb
130 for(i=0,count=0;i<n;i++){
134 temp|=(r[count]>>j)&1;
147 /* there might be a straightforward one-line way to do the below
148 that's portable and totally safe against roundoff, but I haven't
149 thought of it. Therefore, we opt on the side of caution */
150 long _book_maptype1_quantvals(const static_codebook *b){
151 long vals=floor(pow((float)b->entries,1.f/b->dim));
153 /* the above *should* be reliable, but we'll not assume that FP is
154 ever reliable when bitstream sync is at stake; verify via integer
155 means that vals really is the greatest value of dim for which
156 vals^b->bim <= b->entries */
157 /* treat the above as an initial guess */
162 for(i=0;i<b->dim;i++){
166 if(acc<=b->entries && acc1>b->entries){
178 /* unpack the quantized list of values for encode/decode ***********/
179 /* we need to deal with two map types: in map type 1, the values are
180 generated algorithmically (each column of the vector counts through
181 the values in the quant vector). in map type 2, all the values came
182 in in an explicit list. Both value lists must be unpacked */
183 float *_book_unquantize(const static_codebook *b,int n,int *sparsemap){
185 if(b->maptype==1 || b->maptype==2){
187 float mindel=_float32_unpack(b->q_min);
188 float delta=_float32_unpack(b->q_delta);
189 float *r=_ogg_calloc(n*b->dim,sizeof(*r));
191 /* maptype 1 and 2 both use a quantized value vector, but
195 /* most of the time, entries%dimensions == 0, but we need to be
196 well defined. We define that the possible vales at each
197 scalar is values == entries/dim. If entries%dim != 0, we'll
198 have 'too few' values (values*dim<entries), which means that
199 we'll have 'left over' entries; left over entries use zeroed
200 values (and are wasted). So don't generate codebooks like
202 quantvals=_book_maptype1_quantvals(b);
203 for(j=0;j<b->entries;j++){
204 if((sparsemap && b->lengthlist[j]) || !sparsemap){
207 for(k=0;k<b->dim;k++){
208 int index= (j/indexdiv)%quantvals;
209 float val=b->quantlist[index];
210 val=fabs(val)*delta+mindel+last;
211 if(b->q_sequencep)last=val;
213 r[sparsemap[count]*b->dim+k]=val;
215 r[count*b->dim+k]=val;
224 for(j=0;j<b->entries;j++){
225 if((sparsemap && b->lengthlist[j]) || !sparsemap){
228 for(k=0;k<b->dim;k++){
229 float val=b->quantlist[j*b->dim+k];
230 val=fabs(val)*delta+mindel+last;
231 if(b->q_sequencep)last=val;
233 r[sparsemap[count]*b->dim+k]=val;
235 r[count*b->dim+k]=val;
248 void vorbis_staticbook_clear(static_codebook *b){
250 if(b->quantlist)_ogg_free(b->quantlist);
251 if(b->lengthlist)_ogg_free(b->lengthlist);
253 _ogg_free(b->nearest_tree->ptr0);
254 _ogg_free(b->nearest_tree->ptr1);
255 _ogg_free(b->nearest_tree->p);
256 _ogg_free(b->nearest_tree->q);
257 memset(b->nearest_tree,0,sizeof(*b->nearest_tree));
258 _ogg_free(b->nearest_tree);
261 _ogg_free(b->thresh_tree->quantthresh);
262 _ogg_free(b->thresh_tree->quantmap);
263 memset(b->thresh_tree,0,sizeof(*b->thresh_tree));
264 _ogg_free(b->thresh_tree);
267 memset(b,0,sizeof(*b));
271 void vorbis_staticbook_destroy(static_codebook *b){
273 vorbis_staticbook_clear(b);
278 void vorbis_book_clear(codebook *b){
279 /* static book is not cleared; we're likely called on the lookup and
280 the static codebook belongs to the info struct */
281 if(b->valuelist)_ogg_free(b->valuelist);
282 if(b->codelist)_ogg_free(b->codelist);
284 if(b->dec_index)_ogg_free(b->dec_index);
285 if(b->dec_codelengths)_ogg_free(b->dec_codelengths);
286 if(b->dec_firsttable)_ogg_free(b->dec_firsttable);
288 memset(b,0,sizeof(*b));
291 int vorbis_book_init_encode(codebook *c,const static_codebook *s){
293 memset(c,0,sizeof(*c));
295 c->entries=s->entries;
296 c->used_entries=s->entries;
298 c->codelist=_make_words(s->lengthlist,s->entries,0);
299 c->valuelist=_book_unquantize(s,s->entries,NULL);
304 static ogg_uint32_t bitreverse(ogg_uint32_t x){
305 x= ((x>>16)&0x0000ffffUL) | ((x<<16)&0xffff0000UL);
306 x= ((x>> 8)&0x00ff00ffUL) | ((x<< 8)&0xff00ff00UL);
307 x= ((x>> 4)&0x0f0f0f0fUL) | ((x<< 4)&0xf0f0f0f0UL);
308 x= ((x>> 2)&0x33333333UL) | ((x<< 2)&0xccccccccUL);
309 return((x>> 1)&0x55555555UL) | ((x<< 1)&0xaaaaaaaaUL);
312 static int sort32a(const void *a,const void *b){
313 return ( (**(ogg_uint32_t **)a>**(ogg_uint32_t **)b)<<1)-1;
316 /* decode codebook arrangement is more heavily optimized than encode */
317 int vorbis_book_init_decode(codebook *c,const static_codebook *s){
320 memset(c,0,sizeof(*c));
322 /* count actually used entries */
323 for(i=0;i<s->entries;i++)
324 if(s->lengthlist[i]>0)
327 c->entries=s->entries;
331 /* two different remappings go on here.
333 First, we collapse the likely sparse codebook down only to
334 actually represented values/words. This collapsing needs to be
335 indexed as map-valueless books are used to encode original entry
336 positions as integers.
338 Second, we reorder all vectors, including the entry index above,
339 by sorted bitreversed codeword to allow treeless decode. */
343 ogg_uint32_t *codes=_make_words(s->lengthlist,s->entries,c->used_entries);
344 ogg_uint32_t **codep=alloca(sizeof(*codep)*n);
346 if(codes==NULL)goto err_out;
349 codes[i]=bitreverse(codes[i]);
353 qsort(codep,n,sizeof(*codep),sort32a);
355 sortindex=alloca(n*sizeof(*sortindex));
356 c->codelist=_ogg_malloc(n*sizeof(*c->codelist));
357 /* the index is a reverse index */
359 int position=codep[i]-codes;
360 sortindex[position]=i;
364 c->codelist[sortindex[i]]=codes[i];
368 c->valuelist=_book_unquantize(s,n,sortindex);
369 c->dec_index=_ogg_malloc(n*sizeof(*c->dec_index));
371 for(n=0,i=0;i<s->entries;i++)
372 if(s->lengthlist[i]>0)
373 c->dec_index[sortindex[n++]]=i;
375 c->dec_codelengths=_ogg_malloc(n*sizeof(*c->dec_codelengths));
376 for(n=0,i=0;i<s->entries;i++)
377 if(s->lengthlist[i]>0)
378 c->dec_codelengths[sortindex[n++]]=s->lengthlist[i];
380 c->dec_firsttablen=_ilog(c->used_entries)-4; /* this is magic */
381 if(c->dec_firsttablen<5)c->dec_firsttablen=5;
382 if(c->dec_firsttablen>8)c->dec_firsttablen=8;
384 tabn=1<<c->dec_firsttablen;
385 c->dec_firsttable=_ogg_calloc(tabn,sizeof(*c->dec_firsttable));
389 if(c->dec_maxlength<c->dec_codelengths[i])
390 c->dec_maxlength=c->dec_codelengths[i];
391 if(c->dec_codelengths[i]<=c->dec_firsttablen){
392 ogg_uint32_t orig=bitreverse(c->codelist[i]);
393 for(j=0;j<(1<<(c->dec_firsttablen-c->dec_codelengths[i]));j++)
394 c->dec_firsttable[orig|(j<<c->dec_codelengths[i])]=i+1;
398 /* now fill in 'unused' entries in the firsttable with hi/lo search
399 hints for the non-direct-hits */
401 ogg_uint32_t mask=0xfffffffeUL<<(31-c->dec_firsttablen);
405 ogg_uint32_t word=i<<(32-c->dec_firsttablen);
406 if(c->dec_firsttable[bitreverse(word)]==0){
407 while((lo+1)<n && c->codelist[lo+1]<=word)lo++;
408 while( hi<n && word>=(c->codelist[hi]&mask))hi++;
410 /* we only actually have 15 bits per hint to play with here.
411 In order to overflow gracefully (nothing breaks, efficiency
412 just drops), encode as the difference from the extremes. */
414 unsigned long loval=lo;
415 unsigned long hival=n-hi;
417 if(loval>0x7fff)loval=0x7fff;
418 if(hival>0x7fff)hival=0x7fff;
419 c->dec_firsttable[bitreverse(word)]=
420 0x80000000UL | (loval<<15) | hival;
429 vorbis_book_clear(c);
433 static float _dist(int el,float *ref, float *b,int step){
437 float val=(ref[i]-b[i*step]);
443 int _best(codebook *book, float *a, int step){
444 encode_aux_threshmatch *tt=book->c->thresh_tree;
447 encode_aux_nearestmatch *nt=book->c->nearest_tree;
448 encode_aux_pigeonhole *pt=book->c->pigeon_tree;
455 /* do we have a threshhold encode hint? */
458 /* find the quant val of each scalar */
459 for(k=0,o=step*(dim-1);k<dim;k++,o-=step){
462 if(a[o]<tt->quantthresh[i]){
465 if(a[o]>=tt->quantthresh[i-1])
470 for(i++;i<tt->threshvals-1;i++)
471 if(a[o]<tt->quantthresh[i])break;
475 index=(index*tt->quantvals)+tt->quantmap[i];
477 /* regular lattices are easy :-) */
478 if(book->c->lengthlist[index]>0) /* is this unused? If so, we'll
479 use a decision tree after all
485 /* do we have a pigeonhole encode hint? */
487 const static_codebook *c=book->c;
492 /* dealing with sequentialness is a pain in the ass */
497 for(k=0,o=0;k<dim;k++,o+=step){
498 pv=(int)((a[o]-qlast-pt->min)/pt->del);
499 if(pv<0 || pv>=pt->mapentries)break;
500 entry+=pt->pigeonmap[pv]*mul;
502 qlast+=pv*pt->del+pt->min;
505 for(k=0,o=step*(dim-1);k<dim;k++,o-=step){
506 int pv=(int)((a[o]-pt->min)/pt->del);
507 if(pv<0 || pv>=pt->mapentries)break;
508 entry=entry*pt->quantvals+pt->pigeonmap[pv];
512 /* must be within the pigeonholable range; if we quant outside (or
513 in an entry that we define no list for), brute force it */
514 if(k==dim && pt->fitlength[entry]){
515 /* search the abbreviated list */
516 long *list=pt->fitlist+pt->fitmap[entry];
517 for(i=0;i<pt->fitlength[entry];i++){
518 float this=_dist(dim,book->valuelist+list[i]*dim,a,step);
519 if(besti==-1 || this<best){
530 /* optimized using the decision tree */
533 float *p=book->valuelist+nt->p[ptr];
534 float *q=book->valuelist+nt->q[ptr];
536 for(k=0,o=0;k<dim;k++,o+=step)
537 c+=(p[k]-q[k])*(a[o]-(p[k]+q[k])*.5);
549 /* brute force it! */
551 const static_codebook *c=book->c;
554 float *e=book->valuelist;
555 for(i=0;i<book->entries;i++){
556 if(c->lengthlist[i]>0){
557 float this=_dist(dim,e,a,step);
558 if(besti==-1 || this<best){
566 /*if(savebest!=-1 && savebest!=besti){
567 fprintf(stderr,"brute force/pigeonhole disagreement:\n"
569 for(i=0;i<dim*step;i+=step)fprintf(stderr,"%g,",a[i]);
571 "pigeonhole (entry %d, err %g):",savebest,saverr);
572 for(i=0;i<dim;i++)fprintf(stderr,"%g,",
573 (book->valuelist+savebest*dim)[i]);
575 "bruteforce (entry %d, err %g):",besti,best);
576 for(i=0;i<dim;i++)fprintf(stderr,"%g,",
577 (book->valuelist+besti*dim)[i]);
578 fprintf(stderr,"\n");
584 long vorbis_book_codeword(codebook *book,int entry){
585 if(book->c) /* only use with encode; decode optimizations are
586 allowed to break this */
587 return book->codelist[entry];
591 long vorbis_book_codelen(codebook *book,int entry){
592 if(book->c) /* only use with encode; decode optimizations are
593 allowed to break this */
594 return book->c->lengthlist[entry];
600 /* Unit tests of the dequantizer; this stuff will be OK
601 cross-platform, I simply want to be sure that special mapping cases
602 actually work properly; a bug could go unnoticed for a while */
609 full, explicit mapping
616 static long full_quantlist1[]={0,1,2,3, 4,5,6,7, 8,3,6,1};
617 static long partial_quantlist1[]={0,7,2};
620 static_codebook test1={
628 static float *test1_result=NULL;
630 /* linear, full mapping, nonsequential */
631 static_codebook test2={
635 -533200896,1611661312,4,0,
639 static float test2_result[]={-3,-2,-1,0, 1,2,3,4, 5,0,3,-2};
641 /* linear, full mapping, sequential */
642 static_codebook test3={
646 -533200896,1611661312,4,1,
650 static float test3_result[]={-3,-5,-6,-6, 1,3,6,10, 5,5,8,6};
652 /* linear, algorithmic mapping, nonsequential */
653 static_codebook test4={
657 -533200896,1611661312,4,0,
661 static float test4_result[]={-3,-3,-3, 4,-3,-3, -1,-3,-3,
662 -3, 4,-3, 4, 4,-3, -1, 4,-3,
663 -3,-1,-3, 4,-1,-3, -1,-1,-3,
664 -3,-3, 4, 4,-3, 4, -1,-3, 4,
665 -3, 4, 4, 4, 4, 4, -1, 4, 4,
666 -3,-1, 4, 4,-1, 4, -1,-1, 4,
667 -3,-3,-1, 4,-3,-1, -1,-3,-1,
668 -3, 4,-1, 4, 4,-1, -1, 4,-1,
669 -3,-1,-1, 4,-1,-1, -1,-1,-1};
671 /* linear, algorithmic mapping, sequential */
672 static_codebook test5={
676 -533200896,1611661312,4,1,
680 static float test5_result[]={-3,-6,-9, 4, 1,-2, -1,-4,-7,
681 -3, 1,-2, 4, 8, 5, -1, 3, 0,
682 -3,-4,-7, 4, 3, 0, -1,-2,-5,
683 -3,-6,-2, 4, 1, 5, -1,-4, 0,
684 -3, 1, 5, 4, 8,12, -1, 3, 7,
685 -3,-4, 0, 4, 3, 7, -1,-2, 2,
686 -3,-6,-7, 4, 1, 0, -1,-4,-5,
687 -3, 1, 0, 4, 8, 7, -1, 3, 2,
688 -3,-4,-5, 4, 3, 2, -1,-2,-3};
690 void run_test(static_codebook *b,float *comp){
691 float *out=_book_unquantize(b,b->entries,NULL);
696 fprintf(stderr,"_book_unquantize incorrectly returned NULL\n");
700 for(i=0;i<b->entries*b->dim;i++)
701 if(fabs(out[i]-comp[i])>.0001){
702 fprintf(stderr,"disagreement in unquantized and reference data:\n"
703 "position %d, %g != %g\n",i,out[i],comp[i]);
709 fprintf(stderr,"_book_unquantize returned a value array: \n"
710 " correct result should have been NULL\n");
717 /* run the nine dequant tests, and compare to the hand-rolled results */
718 fprintf(stderr,"Dequant test 1... ");
719 run_test(&test1,test1_result);
720 fprintf(stderr,"OK\nDequant test 2... ");
721 run_test(&test2,test2_result);
722 fprintf(stderr,"OK\nDequant test 3... ");
723 run_test(&test3,test3_result);
724 fprintf(stderr,"OK\nDequant test 4... ");
725 run_test(&test4,test4_result);
726 fprintf(stderr,"OK\nDequant test 5... ");
727 run_test(&test5,test5_result);
728 fprintf(stderr,"OK\n\n");