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-2007 *
9 * by the Xiph.Org Foundation http://www.xiph.org/ *
11 ********************************************************************
13 function: residue backend 0, 1 and 2 implementation
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"
34 #if defined(TRAIN_RES) || defined (TRAIN_RESAUX)
39 vorbis_info_residue0 *info;
45 codebook ***partbooks;
54 #if defined(TRAIN_RES) || defined(TRAIN_RESAUX)
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]);
103 look->training_data[k][j]=NULL;
105 /*fprintf(stderr,"\n");*/
108 fprintf(stderr,"min/max residue: %g::%g\n",look->tmin,look->tmax);
110 /*fprintf(stderr,"residue bit usage %f:%f (%f total)\n",
111 (float)look->phrasebits/look->frames,
112 (float)look->postbits/look->frames,
113 (float)(look->postbits+look->phrasebits)/look->frames);*/
117 /*vorbis_info_residue0 *info=look->info;
120 "%ld frames encoded in %ld phrasebits and %ld residue bits "
121 "(%g/frame) \n",look->frames,look->phrasebits,
123 (look->phrasebits+look->resbitsflat)/(float)look->frames);
125 for(j=0;j<look->parts;j++){
127 fprintf(stderr,"\t[%d] == ",j);
128 for(k=0;k<look->stages;k++)
129 if((info->secondstages[j]>>k)&1){
130 fprintf(stderr,"%ld,",look->resbits[j][k]);
131 acc+=look->resbits[j][k];
134 fprintf(stderr,":: (%ld vals) %1.2fbits/sample\n",look->resvals[j],
135 acc?(float)acc/(look->resvals[j]*info->grouping):0);
137 fprintf(stderr,"\n");*/
139 for(j=0;j<look->parts;j++)
140 if(look->partbooks[j])_ogg_free(look->partbooks[j]);
141 _ogg_free(look->partbooks);
142 for(j=0;j<look->partvals;j++)
143 _ogg_free(look->decodemap[j]);
144 _ogg_free(look->decodemap);
146 memset(look,0,sizeof(*look));
151 static int ilog(unsigned int v){
160 static int icount(unsigned int v){
170 void res0_pack(vorbis_info_residue *vr,oggpack_buffer *opb){
171 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
173 oggpack_write(opb,info->begin,24);
174 oggpack_write(opb,info->end,24);
176 oggpack_write(opb,info->grouping-1,24); /* residue vectors to group and
177 code with a partitioned book */
178 oggpack_write(opb,info->partitions-1,6); /* possible partition choices */
179 oggpack_write(opb,info->groupbook,8); /* group huffman book */
181 /* secondstages is a bitmask; as encoding progresses pass by pass, a
182 bitmask of one indicates this partition class has bits to write
184 for(j=0;j<info->partitions;j++){
185 if(ilog(info->secondstages[j])>3){
186 /* yes, this is a minor hack due to not thinking ahead */
187 oggpack_write(opb,info->secondstages[j],3);
188 oggpack_write(opb,1,1);
189 oggpack_write(opb,info->secondstages[j]>>3,5);
191 oggpack_write(opb,info->secondstages[j],4); /* trailing zero */
192 acc+=icount(info->secondstages[j]);
195 oggpack_write(opb,info->booklist[j],8);
199 /* vorbis_info is for range checking */
200 vorbis_info_residue *res0_unpack(vorbis_info *vi,oggpack_buffer *opb){
202 vorbis_info_residue0 *info=_ogg_calloc(1,sizeof(*info));
203 codec_setup_info *ci=vi->codec_setup;
205 info->begin=oggpack_read(opb,24);
206 info->end=oggpack_read(opb,24);
207 info->grouping=oggpack_read(opb,24)+1;
208 info->partitions=oggpack_read(opb,6)+1;
209 info->groupbook=oggpack_read(opb,8);
211 for(j=0;j<info->partitions;j++){
212 int cascade=oggpack_read(opb,3);
213 if(oggpack_read(opb,1))
214 cascade|=(oggpack_read(opb,5)<<3);
215 info->secondstages[j]=cascade;
217 acc+=icount(cascade);
220 info->booklist[j]=oggpack_read(opb,8);
222 if(info->groupbook>=ci->books)goto errout;
224 if(info->booklist[j]>=ci->books)goto errout;
226 /* verify the phrasebook is not specifying an impossible or
227 inconsistent partitioning scheme. */
229 int entries = ci->book_param[info->groupbook]->entries;
230 int dim = ci->book_param[info->groupbook]->dim;
233 partvals *= info->partitions;
234 if(partvals > entries) goto errout;
237 if(partvals != entries) goto errout;
242 res0_free_info(info);
246 vorbis_look_residue *res0_look(vorbis_dsp_state *vd,
247 vorbis_info_residue *vr){
248 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
249 vorbis_look_residue0 *look=_ogg_calloc(1,sizeof(*look));
250 codec_setup_info *ci=vd->vi->codec_setup;
257 look->parts=info->partitions;
258 look->fullbooks=ci->fullbooks;
259 look->phrasebook=ci->fullbooks+info->groupbook;
260 dim=look->phrasebook->dim;
262 look->partbooks=_ogg_calloc(look->parts,sizeof(*look->partbooks));
264 for(j=0;j<look->parts;j++){
265 int stages=ilog(info->secondstages[j]);
267 if(stages>maxstage)maxstage=stages;
268 look->partbooks[j]=_ogg_calloc(stages,sizeof(*look->partbooks[j]));
269 for(k=0;k<stages;k++)
270 if(info->secondstages[j]&(1<<k)){
271 look->partbooks[j][k]=ci->fullbooks+info->booklist[acc++];
273 look->training_data[k][j]=_ogg_calloc(look->partbooks[j][k]->entries,
274 sizeof(***look->training_data));
280 look->partvals=look->phrasebook->entries;
281 look->stages=maxstage;
282 look->decodemap=_ogg_malloc(look->partvals*sizeof(*look->decodemap));
283 for(j=0;j<look->partvals;j++){
285 long mult=look->partvals/look->parts;
286 look->decodemap[j]=_ogg_malloc(dim*sizeof(*look->decodemap[j]));
291 look->decodemap[j][k]=deco;
294 #if defined(TRAIN_RES) || defined (TRAIN_RESAUX)
296 static int train_seq=0;
297 look->train_seq=train_seq++;
303 /* break an abstraction and copy some code for performance purposes */
304 static int local_book_besterror(codebook *book,float *a){
305 int dim=book->dim,i,k,o;
307 encode_aux_threshmatch *tt=book->c->thresh_tree;
309 /* find the quant val of each scalar */
310 for(k=0,o=dim;k<dim;++k){
314 if(val<tt->quantthresh[i]){
315 if(val<tt->quantthresh[i-1]){
317 if(val>=tt->quantthresh[i-1])
322 for(++i;i<tt->threshvals-1;++i)
323 if(val<tt->quantthresh[i])break;
327 best=(best*tt->quantvals)+tt->quantmap[i];
329 /* regular lattices are easy :-) */
331 if(book->c->lengthlist[best]<=0){
332 const static_codebook *c=book->c;
335 float *e=book->valuelist;
337 for(i=0;i<book->entries;i++){
338 if(c->lengthlist[i]>0){
341 float val=(e[j]-a[j]);
344 if(best==-1 || this<bestf){
354 float *ptr=book->valuelist+best*dim;
362 static int _encodepart(oggpack_buffer *opb,float *vec, int n,
363 codebook *book,long *acc){
369 int entry=local_book_besterror(book,vec+i*dim);
376 bits+=vorbis_book_encode(book,entry,opb);
383 static long **_01class(vorbis_block *vb,vorbis_look_residue *vl,
386 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
387 vorbis_info_residue0 *info=look->info;
388 vorbis_info *vi=vb->vd->vi;
390 /* move all this setup out later */
391 int samples_per_partition=info->grouping;
392 int possible_partitions=info->partitions;
393 int n=info->end-info->begin;
395 int partvals=n/samples_per_partition;
396 long **partword=_vorbis_block_alloc(vb,ch*sizeof(*partword));
397 float scale=100./samples_per_partition;
399 /* we find the partition type for each partition of each
400 channel. We'll go back and do the interleaved encoding in a
401 bit. For now, clarity */
404 partword[i]=_vorbis_block_alloc(vb,n/samples_per_partition*sizeof(*partword[i]));
405 memset(partword[i],0,n/samples_per_partition*sizeof(*partword[i]));
408 for(i=0;i<partvals;i++){
409 int offset=i*samples_per_partition+info->begin;
413 for(k=0;k<samples_per_partition;k++){
414 if(fabs(in[j][offset+k])>max)max=fabs(in[j][offset+k]);
415 ent+=fabs(rint(in[j][offset+k]));
419 for(k=0;k<possible_partitions-1;k++)
420 if(max<=info->classmetric1[k] &&
421 (info->classmetric2[k]<0 || (int)ent<info->classmetric2[k]))
434 sprintf(buffer,"resaux_%d.vqd",look->train_seq);
435 of=fopen(buffer,"a");
436 for(j=0;j<partvals;j++)
437 fprintf(of,"%ld, ",partword[i][j]);
448 /* designed for stereo or other modes where the partition size is an
449 integer multiple of the number of channels encoded in the current
451 static long **_2class(vorbis_block *vb,vorbis_look_residue *vl,float **in,
454 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
455 vorbis_info_residue0 *info=look->info;
457 /* move all this setup out later */
458 int samples_per_partition=info->grouping;
459 int possible_partitions=info->partitions;
460 int n=info->end-info->begin;
462 int partvals=n/samples_per_partition;
463 long **partword=_vorbis_block_alloc(vb,sizeof(*partword));
465 #if defined(TRAIN_RES) || defined (TRAIN_RESAUX)
470 partword[0]=_vorbis_block_alloc(vb,n*ch/samples_per_partition*sizeof(*partword[0]));
471 memset(partword[0],0,n*ch/samples_per_partition*sizeof(*partword[0]));
473 for(i=0,l=info->begin/ch;i<partvals;i++){
476 for(j=0;j<samples_per_partition;j+=ch){
477 if(fabs(in[0][l])>magmax)magmax=fabs(in[0][l]);
479 if(fabs(in[k][l])>angmax)angmax=fabs(in[k][l]);
483 for(j=0;j<possible_partitions-1;j++)
484 if(magmax<=info->classmetric1[j] &&
485 angmax<=info->classmetric2[j])
493 sprintf(buffer,"resaux_%d.vqd",look->train_seq);
494 of=fopen(buffer,"a");
495 for(i=0;i<partvals;i++)
496 fprintf(of,"%ld, ",partword[0][i]);
506 static int _01forward(oggpack_buffer *opb,
507 vorbis_block *vb,vorbis_look_residue *vl,
510 int (*encode)(oggpack_buffer *,float *,int,
513 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
514 vorbis_info_residue0 *info=look->info;
516 vorbis_dsp_state *vd=vb->vd;
518 /* move all this setup out later */
519 int samples_per_partition=info->grouping;
520 int possible_partitions=info->partitions;
521 int partitions_per_word=look->phrasebook->dim;
522 int n=info->end-info->begin;
524 int partvals=n/samples_per_partition;
530 for(j=info->begin;j<end;j++){
531 if(in[i][j]>look->tmax)look->tmax=in[i][j];
532 if(in[i][j]<look->tmin)look->tmin=in[i][j];
536 memset(resbits,0,sizeof(resbits));
537 memset(resvals,0,sizeof(resvals));
539 /* we code the partition words for each channel, then the residual
540 words for a partition per channel until we've written all the
541 residual words for that partition word. Then write the next
542 partition channel words... */
544 for(s=0;s<look->stages;s++){
546 for(i=0;i<partvals;){
548 /* first we encode a partition codeword for each channel */
551 long val=partword[j][i];
552 for(k=1;k<partitions_per_word;k++){
553 val*=possible_partitions;
555 val+=partword[j][i+k];
559 if(val<look->phrasebook->entries)
560 look->phrasebits+=vorbis_book_encode(look->phrasebook,val,opb);
561 #if 0 /*def TRAIN_RES*/
569 /* now we encode interleaved residual values for the partitions */
570 for(k=0;k<partitions_per_word && i<partvals;k++,i++){
571 long offset=i*samples_per_partition+info->begin;
574 if(s==0)resvals[partword[j][i]]+=samples_per_partition;
575 if(info->secondstages[partword[j][i]]&(1<<s)){
576 codebook *statebook=look->partbooks[partword[j][i]][s];
579 long *accumulator=NULL;
582 accumulator=look->training_data[s][partword[j][i]];
585 float *samples=in[j]+offset;
586 for(l=0;l<samples_per_partition;l++){
587 if(samples[l]<look->training_min[s][partword[j][i]])
588 look->training_min[s][partword[j][i]]=samples[l];
589 if(samples[l]>look->training_max[s][partword[j][i]])
590 look->training_max[s][partword[j][i]]=samples[l];
595 ret=encode(opb,in[j]+offset,samples_per_partition,
596 statebook,accumulator);
599 resbits[partword[j][i]]+=ret;
610 fprintf(stderr,"%d :: ",vb->mode);
611 for(k=0;k<possible_partitions;k++){
612 fprintf(stderr,"%ld/%1.2g, ",resvals[k],(float)resbits[k]/resvals[k]);
614 totalbits+=resbits[k];
617 fprintf(stderr,":: %ld:%1.2g\n",total,(double)totalbits/total);
623 /* a truncated packet here just means 'stop working'; it's not an error */
624 static int _01inverse(vorbis_block *vb,vorbis_look_residue *vl,
626 long (*decodepart)(codebook *, float *,
627 oggpack_buffer *,int)){
630 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
631 vorbis_info_residue0 *info=look->info;
633 /* move all this setup out later */
634 int samples_per_partition=info->grouping;
635 int partitions_per_word=look->phrasebook->dim;
636 int max=vb->pcmend>>1;
637 int end=(info->end<max?info->end:max);
638 int n=end-info->begin;
641 int partvals=n/samples_per_partition;
642 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
643 int ***partword=alloca(ch*sizeof(*partword));
646 partword[j]=_vorbis_block_alloc(vb,partwords*sizeof(*partword[j]));
648 for(s=0;s<look->stages;s++){
650 /* each loop decodes on partition codeword containing
651 partitions_per_word partitions */
652 for(i=0,l=0;i<partvals;l++){
654 /* fetch the partition word for each channel */
656 int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
658 if(temp==-1)goto eopbreak;
659 partword[j][l]=look->decodemap[temp];
660 if(partword[j][l]==NULL)goto errout;
664 /* now we decode residual values for the partitions */
665 for(k=0;k<partitions_per_word && i<partvals;k++,i++)
667 long offset=info->begin+i*samples_per_partition;
668 if(info->secondstages[partword[j][l][k]]&(1<<s)){
669 codebook *stagebook=look->partbooks[partword[j][l][k]][s];
671 if(decodepart(stagebook,in[j]+offset,&vb->opb,
672 samples_per_partition)==-1)goto eopbreak;
685 /* residue 0 and 1 are just slight variants of one another. 0 is
686 interleaved, 1 is not */
687 long **res0_class(vorbis_block *vb,vorbis_look_residue *vl,
688 float **in,int *nonzero,int ch){
689 /* we encode only the nonzero parts of a bundle */
695 /*return(_01class(vb,vl,in,used,_interleaved_testhack));*/
696 return(_01class(vb,vl,in,used));
701 int res0_forward(vorbis_block *vb,vorbis_look_residue *vl,
702 float **in,float **out,int *nonzero,int ch,
704 /* we encode only the nonzero parts of a bundle */
705 int i,j,used=0,n=vb->pcmend/2;
714 int ret=_01forward(vb,vl,in,used,partword,
715 _interleaved_encodepart);
721 out[i][j]-=in[used][j];
732 int res0_inverse(vorbis_block *vb,vorbis_look_residue *vl,
733 float **in,int *nonzero,int ch){
739 return(_01inverse(vb,vl,in,used,vorbis_book_decodevs_add));
744 int res1_forward(oggpack_buffer *opb,vorbis_block *vb,vorbis_look_residue *vl,
745 float **in,float **out,int *nonzero,int ch,
747 int i,j,used=0,n=vb->pcmend/2;
757 int ret=_01forward(opb,vb,vl,in,used,partword,_encodepart);
763 out[i][j]-=in[used][j];
773 long **res1_class(vorbis_block *vb,vorbis_look_residue *vl,
774 float **in,int *nonzero,int ch){
780 return(_01class(vb,vl,in,used));
785 int res1_inverse(vorbis_block *vb,vorbis_look_residue *vl,
786 float **in,int *nonzero,int ch){
792 return(_01inverse(vb,vl,in,used,vorbis_book_decodev_add));
797 long **res2_class(vorbis_block *vb,vorbis_look_residue *vl,
798 float **in,int *nonzero,int ch){
801 if(nonzero[i])used++;
803 return(_2class(vb,vl,in,ch));
808 /* res2 is slightly more different; all the channels are interleaved
809 into a single vector and encoded. */
811 int res2_forward(oggpack_buffer *opb,
812 vorbis_block *vb,vorbis_look_residue *vl,
813 float **in,float **out,int *nonzero,int ch,
815 long i,j,k,n=vb->pcmend/2,used=0;
817 /* don't duplicate the code; use a working vector hack for now and
818 reshape ourselves into a single channel res1 */
819 /* ugly; reallocs for each coupling pass :-( */
820 float *work=_vorbis_block_alloc(vb,ch*n*sizeof(*work));
823 if(nonzero[i])used++;
824 for(j=0,k=i;j<n;j++,k+=ch)
829 int ret=_01forward(opb,vb,vl,&work,1,partword,_encodepart);
830 /* update the sofar vector */
835 for(j=0,k=i;j<n;j++,k+=ch)
836 sofar[j]+=pcm[j]-work[k];
846 /* duplicate code here as speed is somewhat more important */
847 int res2_inverse(vorbis_block *vb,vorbis_look_residue *vl,
848 float **in,int *nonzero,int ch){
850 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
851 vorbis_info_residue0 *info=look->info;
853 /* move all this setup out later */
854 int samples_per_partition=info->grouping;
855 int partitions_per_word=look->phrasebook->dim;
856 int max=(vb->pcmend*ch)>>1;
857 int end=(info->end<max?info->end:max);
858 int n=end-info->begin;
861 int partvals=n/samples_per_partition;
862 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
863 int **partword=_vorbis_block_alloc(vb,partwords*sizeof(*partword));
865 for(i=0;i<ch;i++)if(nonzero[i])break;
866 if(i==ch)return(0); /* no nonzero vectors */
868 for(s=0;s<look->stages;s++){
869 for(i=0,l=0;i<partvals;l++){
872 /* fetch the partition word */
873 int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
874 if(temp==-1)goto eopbreak;
875 partword[l]=look->decodemap[temp];
876 if(partword[l]==NULL)goto errout;
879 /* now we decode residual values for the partitions */
880 for(k=0;k<partitions_per_word && i<partvals;k++,i++)
881 if(info->secondstages[partword[l][k]]&(1<<s)){
882 codebook *stagebook=look->partbooks[partword[l][k]][s];
885 if(vorbis_book_decodevv_add(stagebook,in,
886 i*samples_per_partition+info->begin,ch,
887 &vb->opb,samples_per_partition)==-1)
900 vorbis_func_residue residue0_exportbundle={
911 vorbis_func_residue residue1_exportbundle={
922 vorbis_func_residue residue2_exportbundle={