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-2001 *
9 * by the XIPHOPHORUS Company http://www.xiph.org/ *
11 ********************************************************************
13 function: residue backend 0 and 1 implementation
14 last mod: $Id: res0.c,v 1.29 2001/06/04 05:56:42 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,
28 #include "vorbis/codec.h"
29 #include "codec_internal.h"
36 vorbis_info_residue0 *info;
43 codebook ***partbooks;
48 } vorbis_look_residue0;
50 vorbis_info_residue *res0_copy_info(vorbis_info_residue *vr){
51 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
52 vorbis_info_residue0 *ret=_ogg_malloc(sizeof(vorbis_info_residue0));
53 memcpy(ret,info,sizeof(vorbis_info_residue0));
57 void res0_free_info(vorbis_info_residue *i){
59 memset(i,0,sizeof(vorbis_info_residue0));
64 void res0_free_look(vorbis_look_residue *i){
67 vorbis_look_residue0 *look=(vorbis_look_residue0 *)i;
71 for(j=0;j<look->parts;j++)
72 if(look->partbooks[j])_ogg_free(look->partbooks[j]);
73 _ogg_free(look->partbooks);
74 for(j=0;j<look->partvals;j++)
75 _ogg_free(look->decodemap[j]);
76 _ogg_free(look->decodemap);
77 memset(i,0,sizeof(vorbis_look_residue0));
82 static int ilog(unsigned int v){
91 static int icount(unsigned int v){
101 void res0_pack(vorbis_info_residue *vr,oggpack_buffer *opb){
102 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
104 oggpack_write(opb,info->begin,24);
105 oggpack_write(opb,info->end,24);
107 oggpack_write(opb,info->grouping-1,24); /* residue vectors to group and
108 code with a partitioned book */
109 oggpack_write(opb,info->partitions-1,6); /* possible partition choices */
110 oggpack_write(opb,info->groupbook,8); /* group huffman book */
112 /* secondstages is a bitmask; as encoding progresses pass by pass, a
113 bitmask of one indicates this partition class has bits to write
115 for(j=0;j<info->partitions;j++){
116 if(ilog(info->secondstages[j])>3){
117 /* yes, this is a minor hack due to not thinking ahead */
118 oggpack_write(opb,info->secondstages[j],3);
119 oggpack_write(opb,1,1);
120 oggpack_write(opb,info->secondstages[j]>>3,5);
122 oggpack_write(opb,info->secondstages[j],4); /* trailing zero */
123 acc+=icount(info->secondstages[j]);
126 oggpack_write(opb,info->booklist[j],8);
130 /* vorbis_info is for range checking */
131 vorbis_info_residue *res0_unpack(vorbis_info *vi,oggpack_buffer *opb){
133 vorbis_info_residue0 *info=_ogg_calloc(1,sizeof(vorbis_info_residue0));
134 codec_setup_info *ci=vi->codec_setup;
136 info->begin=oggpack_read(opb,24);
137 info->end=oggpack_read(opb,24);
138 info->grouping=oggpack_read(opb,24)+1;
139 info->partitions=oggpack_read(opb,6)+1;
140 info->groupbook=oggpack_read(opb,8);
142 for(j=0;j<info->partitions;j++){
143 int cascade=info->secondstages[j]=oggpack_read(opb,3);
144 if(oggpack_read(opb,1))
145 cascade|=(oggpack_read(opb,5)<<3);
146 acc+=icount(cascade);
149 info->booklist[j]=oggpack_read(opb,8);
151 if(info->groupbook>=ci->books)goto errout;
153 if(info->booklist[j]>=ci->books)goto errout;
157 res0_free_info(info);
161 vorbis_look_residue *res0_look (vorbis_dsp_state *vd,vorbis_info_mode *vm,
162 vorbis_info_residue *vr){
163 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
164 vorbis_look_residue0 *look=_ogg_calloc(1,sizeof(vorbis_look_residue0));
165 backend_lookup_state *be=vd->backend_state;
171 look->map=vm->mapping;
173 look->parts=info->partitions;
174 look->fullbooks=be->fullbooks;
175 look->phrasebook=be->fullbooks+info->groupbook;
176 dim=look->phrasebook->dim;
178 look->partbooks=_ogg_calloc(look->parts,sizeof(codebook **));
180 for(j=0;j<look->parts;j++){
181 int stages=ilog(info->secondstages[j]);
183 if(stages>maxstage)maxstage=stages;
184 look->partbooks[j]=_ogg_calloc(stages,sizeof(codebook *));
185 for(k=0;k<stages;k++)
186 if(info->secondstages[j]&(1<<k))
187 look->partbooks[j][k]=be->fullbooks+info->booklist[acc++];
191 look->partvals=rint(pow(look->parts,dim));
192 look->stages=maxstage;
193 look->decodemap=_ogg_malloc(look->partvals*sizeof(int *));
194 for(j=0;j<look->partvals;j++){
196 long mult=look->partvals/look->parts;
197 look->decodemap[j]=_ogg_malloc(dim*sizeof(int));
202 look->decodemap[j][k]=deco;
210 /* does not guard against invalid settings; eg, a subn of 16 and a
211 subgroup request of 32. Max subn of 128 */
212 static int _interleaved_testhack(float *vec,int n,vorbis_look_residue0 *look,
213 int auxparts,int auxpartnum){
214 vorbis_info_residue0 *info=look->info;
216 float max,localmax=0.f;
221 for(i=0;i<n;i++)temp[i]=fabs(vec[i]);
223 /* handle case subgrp==1 outside */
225 if(temp[i]>localmax)localmax=temp[i];
228 for(i=0;i<n;i++)temp[i]=rint(temp[i]);
241 if(temp[i]>localmax)localmax=temp[i];
244 for(i=0;i<auxparts-1;i++)
245 if(auxpartnum<info->blimit[i] &&
246 entropy[info->subgrp[i]]<=info->entmax[i] &&
247 max<=info->ampmax[i])
253 static int _testhack(float *vec,int n,vorbis_look_residue0 *look,
254 int auxparts,int auxpartnum){
255 vorbis_info_residue0 *info=look->info;
257 float max,localmax=0.f;
262 for(i=0;i<n;i++)temp[i]=fabs(vec[i]);
264 /* handle case subgrp==1 outside */
266 if(temp[i]>localmax)localmax=temp[i];
269 for(i=0;i<n;i++)temp[i]=rint(temp[i]);
277 temp[i]=temp[i*2]+temp[i*2+1];
281 if(temp[i]>localmax)localmax=temp[i];
284 for(i=0;i<auxparts-1;i++)
285 if(auxpartnum<info->blimit[i] &&
286 entropy[info->subgrp[i]]<=info->entmax[i] &&
287 max<=info->ampmax[i])
293 static int _interleaved_encodepart(oggpack_buffer *opb,float *vec, int n,
294 codebook *book,vorbis_look_residue0 *look){
301 sprintf(buf,"res0_b%d.vqd",book-look->fullbooks);
306 int entry=vorbis_book_besterror(book,vec+i,step,0);
309 fprintf(f,"%d\n",entry);
312 bits+=vorbis_book_encode(book,entry,opb);
321 static int _encodepart(oggpack_buffer *opb,float *vec, int n,
322 codebook *book,vorbis_look_residue0 *look){
329 sprintf(buf,"res0_b%d.vqd",book-look->fullbooks);
334 int entry=vorbis_book_besterror(book,vec+i*dim,1,0);
337 fprintf(f,"%d\n",entry);
340 bits+=vorbis_book_encode(book,entry,opb);
349 static int _01forward(vorbis_block *vb,vorbis_look_residue *vl,
351 int (*classify)(float *,int,vorbis_look_residue0 *,
353 int (*encode)(oggpack_buffer *,float *,int,
354 codebook *,vorbis_look_residue0 *)){
356 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
357 vorbis_info_residue0 *info=look->info;
359 /* move all this setup out later */
360 int samples_per_partition=info->grouping;
361 int possible_partitions=info->partitions;
362 int partitions_per_word=look->phrasebook->dim;
363 int n=info->end-info->begin;
365 int partvals=n/samples_per_partition;
366 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
367 long **partword=_vorbis_block_alloc(vb,ch*sizeof(long *));
369 partvals=partwords*partitions_per_word;
371 /* we find the patition type for each partition of each
372 channel. We'll go back and do the interleaved encoding in a
373 bit. For now, clarity */
376 partword[i]=_vorbis_block_alloc(vb,n/samples_per_partition*sizeof(long));
377 memset(partword[i],0,n/samples_per_partition*sizeof(long));
380 for(i=info->begin,l=0;i<info->end;i+=samples_per_partition,l++){
382 /* do the partition decision based on the 'entropy'
385 classify(in[j]+i,samples_per_partition,look,possible_partitions,l);
389 /* we code the partition words for each channel, then the residual
390 words for a partition per channel until we've written all the
391 residual words for that partition word. Then write the next
392 partition channel words... */
394 for(s=0;s<look->stages;s++){
395 for(i=info->begin,l=0;i<info->end;){
397 /* first we encode a partition codeword for each channel */
400 long val=partword[j][l];
401 for(k=1;k<partitions_per_word;k++)
402 val= val*possible_partitions+partword[j][l+k];
403 look->phrase+=vorbis_book_encode(look->phrasebook,val,&vb->opb);
407 /* now we encode interleaved residual values for the partitions */
408 for(k=0;k<partitions_per_word;k++,l++,i+=samples_per_partition){
411 if(info->secondstages[partword[j][l]]&(1<<s)){
412 codebook *statebook=look->partbooks[partword[j][l]][s];
414 int ret=encode(&vb->opb,in[j]+i,samples_per_partition,
416 look->bits[partword[j][l]]+=ret;
417 if(s==0)look->vals[partword[j][l]]+=samples_per_partition;
428 /* a truncated packet here just means 'stop working'; it's not an error */
429 static int _01inverse(vorbis_block *vb,vorbis_look_residue *vl,
431 long (*decodepart)(codebook *, float *,
432 oggpack_buffer *,int,int)){
434 long i,j,k,l,s,transend=vb->pcmend/2;
435 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
436 vorbis_info_residue0 *info=look->info;
438 /* move all this setup out later */
439 int samples_per_partition=info->grouping;
440 int partitions_per_word=look->phrasebook->dim;
441 int n=info->end-info->begin;
443 int partvals=n/samples_per_partition;
444 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
445 int ***partword=alloca(ch*sizeof(int **));
446 float **work=alloca(ch*sizeof(float *));
447 partvals=partwords*partitions_per_word;
449 /* make sure we're zeroed up to the start */
451 work[j]=_vorbis_block_alloc(vb,n*sizeof(float));
452 partword[j]=_vorbis_block_alloc(vb,partwords*sizeof(int *));
453 memset(work[j],0,sizeof(float)*n);
456 for(s=0;s<look->stages;s++){
457 for(i=info->begin,l=0;i<info->end;l++){
460 /* fetch the partition word for each channel */
462 int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
463 if(temp==-1)goto eopbreak;
464 partword[j][l]=look->decodemap[temp];
465 if(partword[j][l]==NULL)goto errout;
469 /* now we decode residual values for the partitions */
470 for(k=0;k<partitions_per_word;k++,i+=samples_per_partition)
472 if(info->secondstages[partword[j][l][k]]&(1<<s)){
473 codebook *stagebook=look->partbooks[partword[j][l][k]][s];
475 if(decodepart(stagebook,work[j]+i,&vb->opb,
476 samples_per_partition,0)==-1)goto eopbreak;
487 in[j][i]*=work[j][i];
496 memset(in[j],0,sizeof(float)*transend);
500 /* residue 0 and 1 are just slight variants of one another. 0 is
501 interleaved, 1 is not */
502 int res0_forward(vorbis_block *vb,vorbis_look_residue *vl,
504 return(_01forward(vb,vl,in,ch,_interleaved_testhack,_interleaved_encodepart));
507 int res0_inverse(vorbis_block *vb,vorbis_look_residue *vl,float **in,int ch){
508 return(_01inverse(vb,vl,in,ch,vorbis_book_decodevs));
511 int res1_forward(vorbis_block *vb,vorbis_look_residue *vl,
513 return(_01forward(vb,vl,in,ch,_testhack,_encodepart));
516 int res1_inverse(vorbis_block *vb,vorbis_look_residue *vl,float **in,int ch){
517 return(_01inverse(vb,vl,in,ch,vorbis_book_decodev));
520 vorbis_func_residue residue0_exportbundle={
531 vorbis_func_residue residue1_exportbundle={