libtremor: merge upstream revision 17524 more sanity checking.
[kugel-rb.git] / apps / codecs / libtremor / res012.c
blob1263fa65babf9c751e138ce5bfa9365f24c7485f
1 /********************************************************************
2 * *
3 * THIS FILE IS PART OF THE OggVorbis 'TREMOR' CODEC SOURCE CODE. *
4 * *
5 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
6 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
7 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
8 * *
9 * THE OggVorbis 'TREMOR' SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
10 * BY THE Xiph.Org FOUNDATION http://www.xiph.org/ *
11 * *
12 ********************************************************************
14 function: residue backend 0, 1 and 2 implementation
16 ********************************************************************/
18 #include "config-tremor.h"
19 #include <string.h>
20 #include <math.h>
21 #include "ogg.h"
22 #include "ivorbiscodec.h"
23 #include "codec_internal.h"
24 #include "registry.h"
25 #include "codebook.h"
26 #include "misc.h"
27 #include "os.h"
29 typedef struct {
30 vorbis_info_residue0 *info;
31 int map;
33 int parts;
34 int stages;
35 codebook *fullbooks;
36 codebook *phrasebook;
37 codebook ***partbooks;
39 int partvals;
40 int **decodemap;
42 } vorbis_look_residue0;
44 static void res0_free_info(vorbis_info_residue *i){
45 vorbis_info_residue0 *info=(vorbis_info_residue0 *)i;
46 if(info){
47 memset(info,0,sizeof(*info));
48 _ogg_free(info);
52 static void res0_free_look(vorbis_look_residue *i){
53 int j;
54 if(i){
56 vorbis_look_residue0 *look=(vorbis_look_residue0 *)i;
58 for(j=0;j<look->parts;j++)
59 if(look->partbooks[j])_ogg_free(look->partbooks[j]);
60 _ogg_free(look->partbooks);
61 for(j=0;j<look->partvals;j++)
62 _ogg_free(look->decodemap[j]);
63 _ogg_free(look->decodemap);
65 memset(look,0,sizeof(*look));
66 _ogg_free(look);
70 static int ilog(unsigned int v){
71 int ret=0;
72 while(v){
73 ret++;
74 v>>=1;
76 return(ret);
79 static int icount(unsigned int v){
80 int ret=0;
81 while(v){
82 ret+=v&1;
83 v>>=1;
85 return(ret);
88 /* vorbis_info is for range checking */
89 static vorbis_info_residue *res0_unpack(vorbis_info *vi,oggpack_buffer *opb){
90 int j,acc=0;
91 vorbis_info_residue0 *info=(vorbis_info_residue0 *)_ogg_calloc(1,sizeof(*info));
92 codec_setup_info *ci=(codec_setup_info *)vi->codec_setup;
94 info->begin=oggpack_read(opb,24);
95 info->end=oggpack_read(opb,24);
96 info->grouping=oggpack_read(opb,24)+1;
97 info->partitions=oggpack_read(opb,6)+1;
98 info->groupbook=oggpack_read(opb,8);
100 /* check for premature EOP */
101 if(info->groupbook<0)goto errout;
103 for(j=0;j<info->partitions;j++){
104 int cascade=oggpack_read(opb,3);
105 int cflag=oggpack_read(opb,1);
106 if(cflag<0) goto errout;
107 if(cflag){
108 int c=oggpack_read(opb,5);
109 if(c<0) goto errout;
110 cascade|=(c<<3);
112 info->secondstages[j]=cascade;
114 acc+=icount(cascade);
116 for(j=0;j<acc;j++){
117 int book=oggpack_read(opb,8);
118 if(book<0) goto errout;
119 info->booklist[j]=book;
122 if(info->groupbook>=ci->books)goto errout;
123 for(j=0;j<acc;j++){
124 if(info->booklist[j]>=ci->books)goto errout;
125 if(ci->book_param[info->booklist[j]]->maptype==0)goto errout;
128 /* verify the phrasebook is not specifying an impossible or
129 inconsistent partitioning scheme. */
130 /* modify the phrasebook ranging check from r16327; an early beta
131 encoder had a bug where it used an oversized phrasebook by
132 accident. These files should continue to be playable, but don't
133 allow an exploit */
135 int entries = ci->book_param[info->groupbook]->entries;
136 int dim = ci->book_param[info->groupbook]->dim;
137 int partvals = 1;
138 while(dim>0){
139 partvals *= info->partitions;
140 if(partvals > entries) goto errout;
141 dim--;
143 info->partvals = partvals;
146 return(info);
147 errout:
148 res0_free_info(info);
149 return(NULL);
152 static vorbis_look_residue *res0_look(vorbis_dsp_state *vd,vorbis_info_mode *vm,
153 vorbis_info_residue *vr){
154 vorbis_info_residue0 *info=(vorbis_info_residue0 *)vr;
155 vorbis_look_residue0 *look=(vorbis_look_residue0 *)_ogg_calloc(1,sizeof(*look));
156 codec_setup_info *ci=(codec_setup_info *)vd->vi->codec_setup;
158 int j,k,acc=0;
159 int dim;
160 int maxstage=0;
161 look->info=info;
162 look->map=vm->mapping;
164 look->parts=info->partitions;
165 look->fullbooks=ci->fullbooks;
166 look->phrasebook=ci->fullbooks+info->groupbook;
167 dim=look->phrasebook->dim;
169 look->partbooks=(codebook ***)_ogg_calloc(look->parts,sizeof(*look->partbooks));
171 for(j=0;j<look->parts;j++){
172 int stages=ilog(info->secondstages[j]);
173 if(stages){
174 if(stages>maxstage)maxstage=stages;
175 look->partbooks[j]=(codebook **)_ogg_calloc(stages,sizeof(*look->partbooks[j]));
176 for(k=0;k<stages;k++)
177 if(info->secondstages[j]&(1<<k)){
178 look->partbooks[j][k]=ci->fullbooks+info->booklist[acc++];
179 #ifdef TRAIN_RES
180 look->training_data[k][j]=calloc(look->partbooks[j][k]->entries,
181 sizeof(***look->training_data));
182 #endif
187 look->partvals=look->parts;
188 for(j=1;j<dim;j++)look->partvals*=look->parts;
189 look->stages=maxstage;
190 look->decodemap=(int **)_ogg_malloc(look->partvals*sizeof(*look->decodemap));
191 for(j=0;j<look->partvals;j++){
192 long val=j;
193 long mult=look->partvals/look->parts;
194 look->decodemap[j]=(int *)_ogg_malloc(dim*sizeof(*look->decodemap[j]));
195 for(k=0;k<dim;k++){
196 long deco=val/mult;
197 val-=deco*mult;
198 mult/=look->parts;
199 look->decodemap[j][k]=deco;
203 return(look);
206 /* a truncated packet here just means 'stop working'; it's not an error */
207 static int _01inverse(vorbis_block *vb,vorbis_look_residue *vl,
208 ogg_int32_t **in,int ch,
209 long (*decodepart)(codebook *, ogg_int32_t *,
210 oggpack_buffer *,int,int)){
212 long i,j,k,l,s;
213 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
214 vorbis_info_residue0 *info=look->info;
216 /* move all this setup out later */
217 int samples_per_partition=info->grouping;
218 int partitions_per_word=look->phrasebook->dim;
219 int max=vb->pcmend>>1;
220 int end=(info->end<max?info->end:max);
221 int n=end-info->begin;
223 if(n>0){
224 int partvals=n/samples_per_partition;
225 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
226 int ***partword=(int ***)alloca(ch*sizeof(*partword));
228 for(j=0;j<ch;j++)
229 partword[j]=(int **)_vorbis_block_alloc(vb,partwords*sizeof(*partword[j]));
231 for(s=0;s<look->stages;s++){
233 /* each loop decodes on partition codeword containing
234 partitions_pre_word partitions */
235 for(i=0,l=0;i<partvals;l++){
236 if(s==0){
237 /* fetch the partition word for each channel */
238 for(j=0;j<ch;j++){
239 int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
240 if(temp==-1 || temp>=info->partvals)goto eopbreak;
241 partword[j][l]=look->decodemap[temp];
242 if(partword[j][l]==NULL)goto errout;
246 /* now we decode residual values for the partitions */
247 for(k=0;k<partitions_per_word && i<partvals;k++,i++)
248 for(j=0;j<ch;j++){
249 long offset=info->begin+i*samples_per_partition;
250 if(info->secondstages[partword[j][l][k]]&(1<<s)){
251 codebook *stagebook=look->partbooks[partword[j][l][k]][s];
252 if(stagebook){
253 if(decodepart(stagebook,in[j]+offset,&vb->opb,
254 samples_per_partition,-8)==-1)goto eopbreak;
261 errout:
262 eopbreak:
263 return(0);
266 static int res0_inverse(vorbis_block *vb,vorbis_look_residue *vl,
267 ogg_int32_t **in,int *nonzero,int ch){
268 int i,used=0;
269 for(i=0;i<ch;i++)
270 if(nonzero[i])
271 in[used++]=in[i];
272 if(used)
273 return(_01inverse(vb,vl,in,used,vorbis_book_decodevs_add));
274 else
275 return(0);
278 static int res1_inverse(vorbis_block *vb,vorbis_look_residue *vl,
279 ogg_int32_t **in,int *nonzero,int ch){
280 int i,used=0;
281 for(i=0;i<ch;i++)
282 if(nonzero[i])
283 in[used++]=in[i];
284 if(used)
285 return(_01inverse(vb,vl,in,used,vorbis_book_decodev_add));
286 else
287 return(0);
290 /* duplicate code here as speed is somewhat more important */
291 int res2_inverse(vorbis_block *vb,vorbis_look_residue *vl,
292 ogg_int32_t **in,int *nonzero,int ch)
293 ICODE_ATTR_TREMOR_NOT_MDCT;
294 int res2_inverse(vorbis_block *vb,vorbis_look_residue *vl,
295 ogg_int32_t **in,int *nonzero,int ch){
296 long i,k,l,s;
297 vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
298 vorbis_info_residue0 *info=look->info;
300 /* move all this setup out later */
301 int samples_per_partition=info->grouping;
302 int partitions_per_word=look->phrasebook->dim;
303 int max=(vb->pcmend*ch)>>1;
304 int end=(info->end<max?info->end:max);
305 int n=end-info->begin;
307 if(n>0){
309 int partvals=n/samples_per_partition;
310 int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
311 int **partword=(int **)_vorbis_block_alloc(vb,partwords*sizeof(*partword));
312 int beginoff=info->begin/ch;
314 for(i=0;i<ch;i++)if(nonzero[i])break;
315 if(i==ch)return(0); /* no nonzero vectors */
317 samples_per_partition/=ch;
319 for(s=0;s<look->stages;s++){
320 for(i=0,l=0;i<partvals;l++){
322 if(s==0){
323 /* fetch the partition word */
324 int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
325 if(temp==-1 || temp>info->partvals)goto eopbreak;
326 partword[l]=look->decodemap[temp];
327 if(partword[l]==NULL)goto errout;
330 /* now we decode residual values for the partitions */
331 for(k=0;k<partitions_per_word && i<partvals;k++,i++)
332 if(info->secondstages[partword[l][k]]&(1<<s)){
333 codebook *stagebook=look->partbooks[partword[l][k]][s];
334 if(stagebook){
335 if(vorbis_book_decodevv_add(stagebook,in,
336 i*samples_per_partition+beginoff,ch,
337 &vb->opb,
338 samples_per_partition,-8)==-1)
339 goto eopbreak;
345 errout:
346 eopbreak:
347 return(0);
351 const vorbis_func_residue residue0_exportbundle ICONST_ATTR ={
352 &res0_unpack,
353 &res0_look,
354 &res0_free_info,
355 &res0_free_look,
356 &res0_inverse
359 const vorbis_func_residue residue1_exportbundle ICONST_ATTR ={
360 &res0_unpack,
361 &res0_look,
362 &res0_free_info,
363 &res0_free_look,
364 &res1_inverse
367 const vorbis_func_residue residue2_exportbundle ICONST_ATTR ={
368 &res0_unpack,
369 &res0_look,
370 &res0_free_info,
371 &res0_free_look,
372 &res2_inverse