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: residue backend 0, 1 and 2 implementation
14 last mod: $Id: res0.c,v 1.46 2002/06/28 22:19:37 xiphmont Exp $
16 ********************************************************************/
18 /* Slow, slow, slow, simpleminded and did I mention it was slow? The
19 encode/decode loops are coded for clarity and performance is not
20 yet even a nagging little idea lurking in the shadows. Oh and BTW,
27 #include "vorbis/codec.h"
28 #include "codec_internal.h"
39 vorbis_info_residue0 *info;
45 codebook ***partbooks;
56 long *training_data[8][64];
57 float training_max[8][64];
58 float training_min[8][64];
63 } vorbis_look_residue0;
65 void res0_free_info(vorbis_info_residue *i){
66 vorbis_info_residue0 *info=(vorbis_info_residue0 *)i;
68 memset(info,0,sizeof(*info));
73 void res0_free_look(vorbis_look_residue *i){
77 vorbis_look_residue0 *look=(vorbis_look_residue0 *)i;
82 for(j=0;j<look->parts;j++){
83 /*fprintf(stderr,"partition %d: ",j);*/
85 if(look->training_data[k][j]){
88 codebook *statebook=look->partbooks[j][k];
90 /* long and short into the same bucket by current convention */
91 sprintf(buffer,"res_part%d_pass%d.vqd",j,k);
94 for(l=0;l<statebook->entries;l++)
95 fprintf(of,"%d:%ld\n",l,look->training_data[k][j][l]);
99 /*fprintf(stderr,"%d(%.2f|%.2f) ",k,
100 look->training_min[k][j],look->training_max[k][j]);*/
102 _ogg_free(look->training_data[k][j]);
104 /*fprintf(stderr,"\n");*/
107 fprintf(stderr,"min/max residue: %g::%g\n",look->tmin,look->tmax);
109 /*fprintf(stderr,"residue bit usage %f:%f (%f total)\n",
110 (float)look->phrasebits/look->frames,
111 (float)look->postbits/look->frames,
112 (float)(look->postbits+look->phrasebits)/look->frames);*/
116 /*vorbis_info_residue0 *info=look->info;
119 "%ld frames encoded in %ld phrasebits and %ld residue bits "
120 "(%g/frame) \n",look->frames,look->phrasebits,
122 (look->phrasebits+look->resbitsflat)/(float)look->frames);
124 for(j=0;j<look->parts;j++){
126 fprintf(stderr,"\t[%d] == ",j);
127 for(k=0;k<look->stages;k++)
128 if((info->secondstages[j]>>k)&1){
129 fprintf(stderr,"%ld,",look->resbits[j][k]);
130 acc+=look->resbits[j][k];
133 fprintf(stderr,":: (%ld vals) %1.2fbits/sample\n",look->resvals[j],
134 acc?(float)acc/(look->resvals[j]*info->grouping):0);
136 fprintf(stderr,"\n");*/
138 for(j=0;j<look->parts;j++)
139 if(look->partbooks[j])_ogg_free(look->partbooks[j]);
140 _ogg_free(look->partbooks);
141 for(j=0;j<look->partvals;j++)
142 _ogg_free(look->decodemap[j]);
143 _ogg_free(look->decodemap);
145 memset(look,0,sizeof(*look));
150 static int ilog(unsigned int v){
159 static int icount(unsigned int v){
169 void res0_pack(vorbis_info_residue *vr,oggpack_buffer *opb){
170 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
172 oggpack_write(opb,info->begin,24);
173 oggpack_write(opb,info->end,24);
175 oggpack_write(opb,info->grouping-1,24); /* residue vectors to group and
176 code with a partitioned book */
177 oggpack_write(opb,info->partitions-1,6); /* possible partition choices */
178 oggpack_write(opb,info->groupbook,8); /* group huffman book */
180 /* secondstages is a bitmask; as encoding progresses pass by pass, a
181 bitmask of one indicates this partition class has bits to write
183 for(j=0;j<info->partitions;j++){
184 if(ilog(info->secondstages[j])>3){
185 /* yes, this is a minor hack due to not thinking ahead */
186 oggpack_write(opb,info->secondstages[j],3);
187 oggpack_write(opb,1,1);
188 oggpack_write(opb,info->secondstages[j]>>3,5);
190 oggpack_write(opb,info->secondstages[j],4); /* trailing zero */
191 acc+=icount(info->secondstages[j]);
194 oggpack_write(opb,info->booklist[j],8);
198 /* vorbis_info is for range checking */
199 vorbis_info_residue *res0_unpack(vorbis_info *vi,oggpack_buffer *opb){
201 vorbis_info_residue0 *info=_ogg_calloc(1,sizeof(*info));
202 codec_setup_info *ci=vi->codec_setup;
204 info->begin=oggpack_read(opb,24);
205 info->end=oggpack_read(opb,24);
206 info->grouping=oggpack_read(opb,24)+1;
207 info->partitions=oggpack_read(opb,6)+1;
208 info->groupbook=oggpack_read(opb,8);
210 for(j=0;j<info->partitions;j++){
211 int cascade=oggpack_read(opb,3);
212 if(oggpack_read(opb,1))
213 cascade|=(oggpack_read(opb,5)<<3);
214 info->secondstages[j]=cascade;
216 acc+=icount(cascade);
219 info->booklist[j]=oggpack_read(opb,8);
221 if(info->groupbook>=ci->books)goto errout;
223 if(info->booklist[j]>=ci->books)goto errout;
227 res0_free_info(info);
231 vorbis_look_residue *res0_look(vorbis_dsp_state *vd,
232 vorbis_info_residue *vr){
233 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
234 vorbis_look_residue0 *look=_ogg_calloc(1,sizeof(*look));
235 codec_setup_info *ci=vd->vi->codec_setup;
242 look->parts=info->partitions;
243 look->fullbooks=ci->fullbooks;
244 look->phrasebook=ci->fullbooks+info->groupbook;
245 dim=look->phrasebook->dim;
247 look->partbooks=_ogg_calloc(look->parts,sizeof(*look->partbooks));
249 for(j=0;j<look->parts;j++){
250 int stages=ilog(info->secondstages[j]);
252 if(stages>maxstage)maxstage=stages;
253 look->partbooks[j]=_ogg_calloc(stages,sizeof(*look->partbooks[j]));
254 for(k=0;k<stages;k++)
255 if(info->secondstages[j]&(1<<k)){
256 look->partbooks[j][k]=ci->fullbooks+info->booklist[acc++];
258 look->training_data[k][j]=calloc(look->partbooks[j][k]->entries,
259 sizeof(***look->training_data));
265 look->partvals=rint(pow((float)look->parts,(float)dim));
266 look->stages=maxstage;
267 look->decodemap=_ogg_malloc(look->partvals*sizeof(*look->decodemap));
268 for(j=0;j<look->partvals;j++){
270 long mult=look->partvals/look->parts;
271 look->decodemap[j]=_ogg_malloc(dim*sizeof(*look->decodemap[j]));
276 look->decodemap[j][k]=deco;
281 static int train_seq=0;
282 look->train_seq=train_seq++;
288 /* break an abstraction and copy some code for performance purposes */
289 static int local_book_besterror(codebook *book,float *a){
290 int dim=book->dim,i,k,o;
292 encode_aux_threshmatch *tt=book->c->thresh_tree;
294 /* find the quant val of each scalar */
295 for(k=0,o=dim;k<dim;++k){
299 if(val<tt->quantthresh[i]){
300 if(val<tt->quantthresh[i-1]){
302 if(val>=tt->quantthresh[i-1])
307 for(++i;i<tt->threshvals-1;++i)
308 if(val<tt->quantthresh[i])break;
312 best=(best*tt->quantvals)+tt->quantmap[i];
314 /* regular lattices are easy :-) */
316 if(book->c->lengthlist[best]<=0){
317 const static_codebook *c=book->c;
320 float *e=book->valuelist;
322 for(i=0;i<book->entries;i++){
323 if(c->lengthlist[i]>0){
326 float val=(e[j]-a[j]);
329 if(best==-1 || this<bestf){
339 float *ptr=book->valuelist+best*dim;
347 static int _encodepart(oggpack_buffer *opb,float *vec, int n,
348 codebook *book,long *acc){
354 int entry=local_book_besterror(book,vec+i*dim);
360 bits+=vorbis_book_encode(book,entry,opb);
366 static long **_01class(vorbis_block *vb,vorbis_look_residue *vl,
369 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
370 vorbis_info_residue0 *info=look->info;
371 vorbis_info *vi=vb->vd->vi;
372 codec_setup_info *ci=vi->codec_setup;
374 /* move all this setup out later */
375 int samples_per_partition=info->grouping;
376 int possible_partitions=info->partitions;
377 int n=info->end-info->begin;
379 int partvals=n/samples_per_partition;
380 long **partword=_vorbis_block_alloc(vb,ch*sizeof(*partword));
381 float scale=vi->rate/ci->blocksizes[vb->W]*.001;
382 /* we find the partition type for each partition of each
383 channel. We'll go back and do the interleaved encoding in a
384 bit. For now, clarity */
387 partword[i]=_vorbis_block_alloc(vb,n/samples_per_partition*sizeof(*partword[i]));
388 memset(partword[i],0,n/samples_per_partition*sizeof(*partword[i]));
391 for(i=0;i<partvals;i++){
392 int offset=i*samples_per_partition+info->begin;
393 float cur=offset*scale;
396 for(k=0;k<samples_per_partition;k++)
397 if(fabs(in[j][offset+k])>max)max=fabs(in[j][offset+k]);
399 for(k=0;k<possible_partitions-1;k++)
400 if(max<=info->classmetric1[k] &&
401 cur<info->classmetric2[k])
414 sprintf(buffer,"resaux_%d.vqd",look->train_seq);
415 of=fopen(buffer,"a");
416 for(j=0;j<partvals;j++)
417 fprintf(of,"%ld, ",partword[i][j]);
428 /* designed for stereo or other modes where the partition size is an
429 integer multiple of the number of channels encoded in the current
431 static long **_2class(vorbis_block *vb,vorbis_look_residue *vl,float **in,
434 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
435 vorbis_info_residue0 *info=look->info;
437 /* move all this setup out later */
438 int samples_per_partition=info->grouping;
439 int possible_partitions=info->partitions;
440 int n=info->end-info->begin;
442 int partvals=n/samples_per_partition;
443 long **partword=_vorbis_block_alloc(vb,sizeof(*partword));
450 partword[0]=_vorbis_block_alloc(vb,n*ch/samples_per_partition*sizeof(*partword[0]));
451 memset(partword[0],0,n*ch/samples_per_partition*sizeof(*partword[0]));
453 for(i=0,l=info->begin/ch;i<partvals;i++){
456 for(j=0;j<samples_per_partition;j+=ch){
457 if(fabs(in[0][l])>magmax)magmax=fabs(in[0][l]);
459 if(fabs(in[k][l])>angmax)angmax=fabs(in[k][l]);
463 for(j=0;j<possible_partitions-1;j++)
464 if(magmax<=info->classmetric1[j] &&
465 angmax<=info->classmetric2[j])
473 sprintf(buffer,"resaux_%d.vqd",look->train_seq);
474 of=fopen(buffer,"a");
475 for(i=0;i<partvals;i++)
476 fprintf(of,"%ld, ",partword[0][i]);
486 static int _01forward(vorbis_block *vb,vorbis_look_residue *vl,
489 int (*encode)(oggpack_buffer *,float *,int,
492 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
493 vorbis_info_residue0 *info=look->info;
495 vorbis_dsp_state *vd=vb->vd;
497 /* move all this setup out later */
498 int samples_per_partition=info->grouping;
499 int possible_partitions=info->partitions;
500 int partitions_per_word=look->phrasebook->dim;
501 int n=info->end-info->begin;
503 int partvals=n/samples_per_partition;
509 for(j=info->begin;j<info->end;j++){
510 if(in[i][j]>look->tmax)look->tmax=in[i][j];
511 if(in[i][j]<look->tmin)look->tmin=in[i][j];
515 memset(resbits,0,sizeof(resbits));
516 memset(resvals,0,sizeof(resvals));
518 /* we code the partition words for each channel, then the residual
519 words for a partition per channel until we've written all the
520 residual words for that partition word. Then write the next
521 partition channel words... */
523 for(s=0;s<look->stages;s++){
525 for(i=0;i<partvals;){
527 /* first we encode a partition codeword for each channel */
530 long val=partword[j][i];
531 for(k=1;k<partitions_per_word;k++){
532 val*=possible_partitions;
534 val+=partword[j][i+k];
538 if(val<look->phrasebook->entries)
539 look->phrasebits+=vorbis_book_encode(look->phrasebook,val,&vb->opb);
548 /* now we encode interleaved residual values for the partitions */
549 for(k=0;k<partitions_per_word && i<partvals;k++,i++){
550 long offset=i*samples_per_partition+info->begin;
553 if(s==0)resvals[partword[j][i]]+=samples_per_partition;
554 if(info->secondstages[partword[j][i]]&(1<<s)){
555 codebook *statebook=look->partbooks[partword[j][i]][s];
558 long *accumulator=NULL;
561 accumulator=look->training_data[s][partword[j][i]];
564 float *samples=in[j]+offset;
565 for(l=0;l<samples_per_partition;l++){
566 if(samples[l]<look->training_min[s][partword[j][i]])
567 look->training_min[s][partword[j][i]]=samples[l];
568 if(samples[l]>look->training_max[s][partword[j][i]])
569 look->training_max[s][partword[j][i]]=samples[l];
574 ret=encode(&vb->opb,in[j]+offset,samples_per_partition,
575 statebook,accumulator);
578 resbits[partword[j][i]]+=ret;
589 fprintf(stderr,"%d :: ",vb->mode);
590 for(k=0;k<possible_partitions;k++){
591 fprintf(stderr,"%ld/%1.2g, ",resvals[k],(float)resbits[k]/resvals[k]);
593 totalbits+=resbits[k];
596 fprintf(stderr,":: %ld:%1.2g\n",total,(double)totalbits/total);
601 /* a truncated packet here just means 'stop working'; it's not an error */
602 static int _01inverse(vorbis_block *vb,vorbis_look_residue *vl,
604 long (*decodepart)(codebook *, float *,
605 oggpack_buffer *,int)){
608 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
609 vorbis_info_residue0 *info=look->info;
611 /* move all this setup out later */
612 int samples_per_partition=info->grouping;
613 int partitions_per_word=look->phrasebook->dim;
614 int n=info->end-info->begin;
616 int partvals=n/samples_per_partition;
617 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
618 int ***partword=alloca(ch*sizeof(*partword));
621 partword[j]=_vorbis_block_alloc(vb,partwords*sizeof(*partword[j]));
623 for(s=0;s<look->stages;s++){
625 /* each loop decodes on partition codeword containing
626 partitions_pre_word partitions */
627 for(i=0,l=0;i<partvals;l++){
629 /* fetch the partition word for each channel */
631 int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
632 if(temp==-1)goto eopbreak;
633 partword[j][l]=look->decodemap[temp];
634 if(partword[j][l]==NULL)goto errout;
638 /* now we decode residual values for the partitions */
639 for(k=0;k<partitions_per_word && i<partvals;k++,i++)
641 long offset=info->begin+i*samples_per_partition;
642 if(info->secondstages[partword[j][l][k]]&(1<<s)){
643 codebook *stagebook=look->partbooks[partword[j][l][k]][s];
645 if(decodepart(stagebook,in[j]+offset,&vb->opb,
646 samples_per_partition)==-1)goto eopbreak;
659 /* residue 0 and 1 are just slight variants of one another. 0 is
660 interleaved, 1 is not */
661 long **res0_class(vorbis_block *vb,vorbis_look_residue *vl,
662 float **in,int *nonzero,int ch){
663 /* we encode only the nonzero parts of a bundle */
669 /*return(_01class(vb,vl,in,used,_interleaved_testhack));*/
670 return(_01class(vb,vl,in,used));
675 int res0_forward(vorbis_block *vb,vorbis_look_residue *vl,
676 float **in,float **out,int *nonzero,int ch,
678 /* we encode only the nonzero parts of a bundle */
679 int i,j,used=0,n=vb->pcmend/2;
688 int ret=_01forward(vb,vl,in,used,partword,
689 _interleaved_encodepart);
695 out[i][j]-=in[used][j];
706 int res0_inverse(vorbis_block *vb,vorbis_look_residue *vl,
707 float **in,int *nonzero,int ch){
713 return(_01inverse(vb,vl,in,used,vorbis_book_decodevs_add));
718 int res1_forward(vorbis_block *vb,vorbis_look_residue *vl,
719 float **in,float **out,int *nonzero,int ch,
721 int i,j,used=0,n=vb->pcmend/2;
731 int ret=_01forward(vb,vl,in,used,partword,_encodepart);
737 out[i][j]-=in[used][j];
747 long **res1_class(vorbis_block *vb,vorbis_look_residue *vl,
748 float **in,int *nonzero,int ch){
754 return(_01class(vb,vl,in,used));
759 int res1_inverse(vorbis_block *vb,vorbis_look_residue *vl,
760 float **in,int *nonzero,int ch){
766 return(_01inverse(vb,vl,in,used,vorbis_book_decodev_add));
771 long **res2_class(vorbis_block *vb,vorbis_look_residue *vl,
772 float **in,int *nonzero,int ch){
775 if(nonzero[i])used++;
777 return(_2class(vb,vl,in,ch));
782 /* res2 is slightly more different; all the channels are interleaved
783 into a single vector and encoded. */
785 int res2_forward(vorbis_block *vb,vorbis_look_residue *vl,
786 float **in,float **out,int *nonzero,int ch,
788 long i,j,k,n=vb->pcmend/2,used=0;
790 /* don't duplicate the code; use a working vector hack for now and
791 reshape ourselves into a single channel res1 */
792 /* ugly; reallocs for each coupling pass :-( */
793 float *work=_vorbis_block_alloc(vb,ch*n*sizeof(*work));
796 if(nonzero[i])used++;
797 for(j=0,k=i;j<n;j++,k+=ch)
802 int ret=_01forward(vb,vl,&work,1,partword,_encodepart);
803 /* update the sofar vector */
808 for(j=0,k=i;j<n;j++,k+=ch)
809 sofar[j]+=pcm[j]-work[k];
819 /* duplicate code here as speed is somewhat more important */
820 int res2_inverse(vorbis_block *vb,vorbis_look_residue *vl,
821 float **in,int *nonzero,int ch){
823 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
824 vorbis_info_residue0 *info=look->info;
826 /* move all this setup out later */
827 int samples_per_partition=info->grouping;
828 int partitions_per_word=look->phrasebook->dim;
829 int n=info->end-info->begin;
831 int partvals=n/samples_per_partition;
832 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
833 int **partword=_vorbis_block_alloc(vb,partwords*sizeof(*partword));
835 for(i=0;i<ch;i++)if(nonzero[i])break;
836 if(i==ch)return(0); /* no nonzero vectors */
838 for(s=0;s<look->stages;s++){
839 for(i=0,l=0;i<partvals;l++){
842 /* fetch the partition word */
843 int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
844 if(temp==-1)goto eopbreak;
845 partword[l]=look->decodemap[temp];
846 if(partword[l]==NULL)goto errout;
849 /* now we decode residual values for the partitions */
850 for(k=0;k<partitions_per_word && i<partvals;k++,i++)
851 if(info->secondstages[partword[l][k]]&(1<<s)){
852 codebook *stagebook=look->partbooks[partword[l][k]][s];
855 if(vorbis_book_decodevv_add(stagebook,in,
856 i*samples_per_partition+info->begin,ch,
857 &vb->opb,samples_per_partition)==-1)
870 vorbis_func_residue residue0_exportbundle={
881 vorbis_func_residue residue1_exportbundle={
892 vorbis_func_residue residue2_exportbundle={