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: channel mapping 0 implementation
14 last mod: $Id: mapping0.c,v 1.37 2001/10/02 00:14:31 segher Exp $
16 ********************************************************************/
23 #include "vorbis/codec.h"
24 #include "codec_internal.h"
26 #include "bitbuffer.h"
31 /* simplistic, wasteful way of doing this (unique lookup for each
32 mode/submapping); there should be a central repository for
33 identical lookups. That will require minor work, so I'm putting it
36 Why a lookup for each backend in a given mode? Because the
37 blocksize is set by the mode, and low backend lookups may require
38 parameters from other areas of the mode/mapping */
40 extern int analysis_noisy;
44 vorbis_info_mode *mode;
45 vorbis_info_mapping0 *map;
47 vorbis_look_time **time_look;
48 vorbis_look_floor **floor_look;
50 vorbis_look_residue **residue_look;
51 vorbis_look_psy *psy_look[2];
53 vorbis_func_time **time_func;
54 vorbis_func_floor **floor_func;
55 vorbis_func_residue **residue_func;
58 long lastframe; /* if a different mode is called, we need to
60 } vorbis_look_mapping0;
62 static vorbis_info_mapping *mapping0_copy_info(vorbis_info_mapping *vm){
63 vorbis_info_mapping0 *info=(vorbis_info_mapping0 *)vm;
64 vorbis_info_mapping0 *ret=_ogg_malloc(sizeof(*ret));
65 memcpy(ret,info,sizeof(*ret));
69 static void mapping0_free_info(vorbis_info_mapping *i){
70 vorbis_info_mapping0 *info=(vorbis_info_mapping0 *)i;
72 memset(info,0,sizeof(*info));
77 static void mapping0_free_look(vorbis_look_mapping *look){
79 vorbis_look_mapping0 *l=(vorbis_look_mapping0 *)look;
81 drft_clear(&l->fft_look);
83 for(i=0;i<l->map->submaps;i++){
84 l->time_func[i]->free_look(l->time_look[i]);
85 l->floor_func[i]->free_look(l->floor_look[i]);
86 l->residue_func[i]->free_look(l->residue_look[i]);
88 if(l->psy_look[1] && l->psy_look[1]!=l->psy_look[0]){
89 _vp_psy_clear(l->psy_look[1]);
90 _ogg_free(l->psy_look[1]);
93 _vp_psy_clear(l->psy_look[0]);
94 _ogg_free(l->psy_look[0]);
96 _ogg_free(l->time_func);
97 _ogg_free(l->floor_func);
98 _ogg_free(l->residue_func);
99 _ogg_free(l->time_look);
100 _ogg_free(l->floor_look);
101 _ogg_free(l->residue_look);
102 memset(l,0,sizeof(*l));
107 static vorbis_look_mapping *mapping0_look(vorbis_dsp_state *vd,vorbis_info_mode *vm,
108 vorbis_info_mapping *m){
110 vorbis_info *vi=vd->vi;
111 codec_setup_info *ci=vi->codec_setup;
112 vorbis_look_mapping0 *look=_ogg_calloc(1,sizeof(*look));
113 vorbis_info_mapping0 *info=look->map=(vorbis_info_mapping0 *)m;
116 look->time_look=_ogg_calloc(info->submaps,sizeof(*look->time_look));
117 look->floor_look=_ogg_calloc(info->submaps,sizeof(*look->floor_look));
119 look->residue_look=_ogg_calloc(info->submaps,sizeof(*look->residue_look));
121 look->time_func=_ogg_calloc(info->submaps,sizeof(*look->time_func));
122 look->floor_func=_ogg_calloc(info->submaps,sizeof(*look->floor_func));
123 look->residue_func=_ogg_calloc(info->submaps,sizeof(*look->residue_func));
125 for(i=0;i<info->submaps;i++){
126 int timenum=info->timesubmap[i];
127 int floornum=info->floorsubmap[i];
128 int resnum=info->residuesubmap[i];
130 look->time_func[i]=_time_P[ci->time_type[timenum]];
131 look->time_look[i]=look->time_func[i]->
132 look(vd,vm,ci->time_param[timenum]);
133 look->floor_func[i]=_floor_P[ci->floor_type[floornum]];
134 look->floor_look[i]=look->floor_func[i]->
135 look(vd,vm,ci->floor_param[floornum]);
136 look->residue_func[i]=_residue_P[ci->residue_type[resnum]];
137 look->residue_look[i]=look->residue_func[i]->
138 look(vd,vm,ci->residue_param[resnum]);
141 if(ci->psys && vd->analysisp){
142 if(info->psy[0] != info->psy[1]){
144 int psynum=info->psy[0];
145 look->psy_look[0]=_ogg_calloc(1,sizeof(*look->psy_look[0]));
146 _vp_psy_init(look->psy_look[0],ci->psy_param[psynum],
148 ci->blocksizes[vm->blockflag]/2,vi->rate);
151 look->psy_look[1]=_ogg_calloc(1,sizeof(*look->psy_look[1]));
152 _vp_psy_init(look->psy_look[1],ci->psy_param[psynum],
154 ci->blocksizes[vm->blockflag]/2,vi->rate);
157 int psynum=info->psy[0];
158 look->psy_look[0]=_ogg_calloc(1,sizeof(*look->psy_look[0]));
159 look->psy_look[1]=look->psy_look[0];
160 _vp_psy_init(look->psy_look[0],ci->psy_param[psynum],
162 ci->blocksizes[vm->blockflag]/2,vi->rate);
167 look->ch=vi->channels;
169 if(vd->analysisp)drft_init(&look->fft_look,ci->blocksizes[vm->blockflag]);
173 static int ilog2(unsigned int v){
182 static void mapping0_pack(vorbis_info *vi,vorbis_info_mapping *vm,oggpack_buffer *opb){
184 vorbis_info_mapping0 *info=(vorbis_info_mapping0 *)vm;
186 /* another 'we meant to do it this way' hack... up to beta 4, we
187 packed 4 binary zeros here to signify one submapping in use. We
188 now redefine that to mean four bitflags that indicate use of
189 deeper features; bit0:submappings, bit1:coupling,
190 bit2,3:reserved. This is backward compatable with all actual uses
194 oggpack_write(opb,1,1);
195 oggpack_write(opb,info->submaps-1,4);
197 oggpack_write(opb,0,1);
199 if(info->coupling_steps>0){
200 oggpack_write(opb,1,1);
201 oggpack_write(opb,info->coupling_steps-1,8);
203 for(i=0;i<info->coupling_steps;i++){
204 oggpack_write(opb,info->coupling_mag[i],ilog2(vi->channels));
205 oggpack_write(opb,info->coupling_ang[i],ilog2(vi->channels));
208 oggpack_write(opb,0,1);
210 oggpack_write(opb,0,2); /* 2,3:reserved */
212 /* we don't write the channel submappings if we only have one... */
214 for(i=0;i<vi->channels;i++)
215 oggpack_write(opb,info->chmuxlist[i],4);
217 for(i=0;i<info->submaps;i++){
218 oggpack_write(opb,info->timesubmap[i],8);
219 oggpack_write(opb,info->floorsubmap[i],8);
220 oggpack_write(opb,info->residuesubmap[i],8);
224 /* also responsible for range checking */
225 static vorbis_info_mapping *mapping0_unpack(vorbis_info *vi,oggpack_buffer *opb){
227 vorbis_info_mapping0 *info=_ogg_calloc(1,sizeof(*info));
228 codec_setup_info *ci=vi->codec_setup;
229 memset(info,0,sizeof(*info));
231 if(oggpack_read(opb,1))
232 info->submaps=oggpack_read(opb,4)+1;
236 if(oggpack_read(opb,1)){
237 info->coupling_steps=oggpack_read(opb,8)+1;
239 for(i=0;i<info->coupling_steps;i++){
240 int testM=info->coupling_mag[i]=oggpack_read(opb,ilog2(vi->channels));
241 int testA=info->coupling_ang[i]=oggpack_read(opb,ilog2(vi->channels));
246 testM>=vi->channels ||
247 testA>=vi->channels) goto err_out;
252 if(oggpack_read(opb,2)>0)goto err_out; /* 2,3:reserved */
255 for(i=0;i<vi->channels;i++){
256 info->chmuxlist[i]=oggpack_read(opb,4);
257 if(info->chmuxlist[i]>=info->submaps)goto err_out;
260 for(i=0;i<info->submaps;i++){
261 info->timesubmap[i]=oggpack_read(opb,8);
262 if(info->timesubmap[i]>=ci->times)goto err_out;
263 info->floorsubmap[i]=oggpack_read(opb,8);
264 if(info->floorsubmap[i]>=ci->floors)goto err_out;
265 info->residuesubmap[i]=oggpack_read(opb,8);
266 if(info->residuesubmap[i]>=ci->residues)goto err_out;
272 mapping0_free_info(info);
279 #include "envelope.h"
284 /* no time mapping implementation for now */
286 static int mapping0_forward(vorbis_block *vb,vorbis_look_mapping *l){
287 vorbis_dsp_state *vd=vb->vd;
288 vorbis_info *vi=vd->vi;
289 codec_setup_info *ci=vi->codec_setup;
290 backend_lookup_state *b=vb->vd->backend_state;
291 vorbis_look_mapping0 *look=(vorbis_look_mapping0 *)l;
292 vorbis_info_mapping0 *info=look->map;
293 vorbis_info_mode *mode=look->mode;
294 vorbis_block_internal *vbi=(vorbis_block_internal *)vb->internal;
297 float *window=b->window[vb->W][vb->lW][vb->nW][mode->windowtype];
298 int *nonzero=alloca(sizeof(*nonzero)*vi->channels);
300 float *work=_vorbis_block_alloc(vb,n*sizeof(*work));
302 float global_ampmax=vbi->ampmax;
303 float *local_ampmax=alloca(sizeof(*local_ampmax)*vi->channels);
306 /* we differentiate between short and long block types to help the
307 masking engine; the window shapes also matter.
308 impulse block (a short block in which an impulse occurs)
309 padding block (a short block that pads between a transitional
310 long block and an impulse block, or vice versa)
311 transition block (the wqeird one; a long block with the transition
312 window; affects bass/midrange response and that must be
313 accounted for in masking)
314 long block (run of the mill long block)
318 if(!vb->lW || !vb->nW)
319 blocktype=BLOCKTYPE_TRANSITION;
321 blocktype=BLOCKTYPE_LONG;
323 /* right now we're missing the infrastructure to distingush the
325 blocktype=BLOCKTYPE_IMPULSE;
328 for(i=0;i<vi->channels;i++){
331 /* the following makes things clearer to *me* anyway */
332 float *pcm =vb->pcm[i];
334 float *logfft =pcm+n/2;
338 float *codedflr=pcm+n/2;
340 float *logmask =work+n/2;*/
342 /* window the PCM data */
344 fft[j]=pcm[j]*=window[j];
346 /* transform the PCM data */
347 /* only MDCT right now.... */
348 mdct_forward(b->transform[vb->W][0],pcm,pcm);
350 /* FFT yields more accurate tonal estimation (not phase sensitive) */
351 drft_forward(&look->fft_look,fft);
354 local_ampmax[i]=logfft[0];
356 float temp=scale*FAST_HYPOT(fft[j],fft[j+1]);
357 temp=logfft[(j+1)>>1]=todB(&temp);
358 if(temp>local_ampmax[i])local_ampmax[i]=temp;
360 if(local_ampmax[i]>global_ampmax)global_ampmax=local_ampmax[i];
362 _analysis_output("fft",seq+i,logfft,n/2,1,0);
365 for(i=0;i<vi->channels;i++){
366 int submap=info->chmuxlist[i];
368 /* the following makes things clearer to *me* anyway */
369 float *mdct =vb->pcm[i];
371 float *codedflr=mdct+n/2;
372 float *logfft =mdct+n/2;
374 float *logmdct =work;
375 float *logmax =mdct+n/2;
376 float *logmask =work+n/2;
379 logmdct[j]=todB(mdct+j);
380 _analysis_output("mdct",seq+i,logmdct,n/2,1,0);
381 _analysis_output("lmdct",seq+i,mdct,n/2,0,0);
384 /* perform psychoacoustics; do masking */
385 _vp_compute_mask(look->psy_look[blocktype],
388 logfft, /* -> logmax */
393 ci->blocksizes[vb->lW]/2);
395 _analysis_output("mask",seq+i,logmask,n/2,1,0);
396 /* perform floor encoding */
397 nonzero[i]=look->floor_func[submap]->
398 forward(vb,look->floor_look[submap],
407 _analysis_output("mdct2",seq+i,mdct,n/2,1,1);
408 _vp_remove_floor(look->psy_look[blocktype],
417 if(fabs(res[j])>1200){
419 fprintf(stderr,"%ld ",seq+i);
422 _analysis_output("res",seq+i,res,n/2,1,0);
423 _analysis_output("codedflr",seq+i,codedflr,n/2,1,1);
427 vbi->ampmax=global_ampmax;
429 /* partition based prequantization and channel coupling */
430 /* Steps in prequant and coupling:
432 down-couple/down-quantize from perfect residue -> quantized vector
433 classify by this first quantized vector
436 encode quantized vector; add encoded values to 'so-far' vector
437 more? [not yet at bitrate/not yet at target]
439 down-couple/down-quantize from perfect-'so-far' ->
440 quantized vector; when subtracting coupling,
441 account for +/- out-of-phase component
448 quantization in each iteration is done (after circular normalization
449 in coupling) using a by-iteration quantization granule value.
454 float **quantized=alloca(sizeof(*quantized)*vi->channels);
455 float **sofar=alloca(sizeof(*sofar)*vi->channels);
457 long ***classifications=alloca(sizeof(*classifications)*info->submaps);
458 float ***pcmbundle=alloca(sizeof(*pcmbundle)*info->submaps);
459 float ***sobundle=alloca(sizeof(*sobundle)*info->submaps);
460 int **zerobundle=alloca(sizeof(*zerobundle)*info->submaps);
461 int *chbundle=alloca(sizeof(*chbundle)*info->submaps);
464 /* play a little loose with this abstraction */
465 int quant_passes=look->psy_look[blocktype]->vi->coupling_passes;
468 for(i=0;i<vi->channels;i++){
469 quantized[i]=pcm[i]+n/2;
470 sofar[i]=_vorbis_block_alloc(vb,n/2*sizeof(*sofar[i]));
471 memset(sofar[i],0,sizeof(*sofar[i])*n/2);
474 pcmbundle[0]=alloca(sizeof(*pcmbundle[0])*vi->channels);
475 sobundle[0]=alloca(sizeof(*sobundle[0])*vi->channels);
476 zerobundle[0]=alloca(sizeof(*zerobundle[0])*vi->channels);
478 /* initial down-quantized coupling */
480 if(info->coupling_steps==0){
481 /* this assumes all or nothing coupling right now. it should pass
482 through any channels left uncoupled, but it doesn't do that now */
483 for(i=0;i<vi->channels;i++){
485 float *lqua=quantized[i];
490 _vp_quantize_couple(look->psy_look[blocktype],
499 for(i=0;i<vi->channels;i++)
500 _analysis_output("quant",seq+i,quantized[i],n/2,1,0);
503 /* classify, by submap */
505 for(i=0;i<info->submaps;i++){
507 pcmbundle[i]=pcmbundle[0]+chcounter;
508 sobundle[i]=sobundle[0]+chcounter;
509 zerobundle[i]=zerobundle[0]+chcounter;
511 for(j=0;j<vi->channels;j++){
512 if(info->chmuxlist[j]==i){
514 zerobundle[i][ch_in_bundle]=1;
516 zerobundle[i][ch_in_bundle]=0;
517 pcmbundle[i][ch_in_bundle]=quantized[j];
518 sobundle[i][ch_in_bundle++]=sofar[j];
521 chbundle[i]=ch_in_bundle;
522 chcounter+=ch_in_bundle;
524 classifications[i]=look->residue_func[i]->
525 class(vb,look->residue_look[i],pcmbundle[i],zerobundle[i],chbundle[i]);
528 /* actual encoding loop */
531 /* perform residue encoding of this pass's quantized residue
532 vector, according residue mapping */
534 for(j=0;j<info->submaps;j++)
535 look->residue_func[j]->
536 forward(vb,look->residue_look[j],
537 pcmbundle[j],sobundle[j],zerobundle[j],chbundle[j],
538 i,classifications[j]);
541 /* bitrate management decision hook; the following if() is where
542 we tell progressive encoding to halt, right now it just
543 avoids falling off the edge */
544 if(i>=quant_passes /* || yadda yadda */)stopflag=1;
547 /* down-couple/down-quantize from perfect-'so-far' ->
548 new quantized vector */
549 if(info->coupling_steps==0){
550 /* this assumes all or nothing coupling right now. it should pass
551 through any channels left uncoupled, but it doesn't do that now */
552 for(i=0;i<vi->channels;i++){
554 float *lsof=sofar[i];
555 float *lqua=quantized[i];
557 lqua[j]=lpcm[j]-lsof[j];
560 _vp_quantize_couple(look->psy_look[blocktype],
569 /* steady as she goes */
574 look->lastframe=vb->sequence;
578 static int mapping0_inverse(vorbis_block *vb,vorbis_look_mapping *l){
579 vorbis_dsp_state *vd=vb->vd;
580 vorbis_info *vi=vd->vi;
581 codec_setup_info *ci=vi->codec_setup;
582 backend_lookup_state *b=vd->backend_state;
583 vorbis_look_mapping0 *look=(vorbis_look_mapping0 *)l;
584 vorbis_info_mapping0 *info=look->map;
585 vorbis_info_mode *mode=look->mode;
587 long n=vb->pcmend=ci->blocksizes[vb->W];
589 float *window=b->window[vb->W][vb->lW][vb->nW][mode->windowtype];
590 float **pcmbundle=alloca(sizeof(*pcmbundle)*vi->channels);
591 int *zerobundle=alloca(sizeof(*zerobundle)*vi->channels);
593 int *nonzero =alloca(sizeof(*nonzero)*vi->channels);
594 void **floormemo=alloca(sizeof(*floormemo)*vi->channels);
596 /* time domain information decode (note that applying the
597 information would have to happen later; we'll probably add a
598 function entry to the harness for that later */
599 /* NOT IMPLEMENTED */
601 /* recover the spectral envelope; store it in the PCM vector for now */
602 for(i=0;i<vi->channels;i++){
603 int submap=info->chmuxlist[i];
604 floormemo[i]=look->floor_func[submap]->
605 inverse1(vb,look->floor_look[submap]);
610 memset(vb->pcm[i],0,sizeof(*vb->pcm[i])*n/2);
613 /* channel coupling can 'dirty' the nonzero listing */
614 for(i=0;i<info->coupling_steps;i++){
615 if(nonzero[info->coupling_mag[i]] ||
616 nonzero[info->coupling_ang[i]]){
617 nonzero[info->coupling_mag[i]]=1;
618 nonzero[info->coupling_ang[i]]=1;
622 /* recover the residue into our working vectors */
623 for(i=0;i<info->submaps;i++){
625 for(j=0;j<vi->channels;j++){
626 if(info->chmuxlist[j]==i){
628 zerobundle[ch_in_bundle]=1;
630 zerobundle[ch_in_bundle]=0;
631 pcmbundle[ch_in_bundle++]=vb->pcm[j];
635 look->residue_func[i]->inverse(vb,look->residue_look[i],
636 pcmbundle,zerobundle,ch_in_bundle);
639 /* channel coupling */
640 for(i=info->coupling_steps-1;i>=0;i--){
641 float *pcmM=vb->pcm[info->coupling_mag[i]];
642 float *pcmA=vb->pcm[info->coupling_ang[i]];
667 /* compute and apply spectral envelope */
668 for(i=0;i<vi->channels;i++){
669 float *pcm=vb->pcm[i];
670 int submap=info->chmuxlist[i];
671 look->floor_func[submap]->
672 inverse2(vb,look->floor_look[submap],floormemo[i],pcm);
675 /* transform the PCM data; takes PCM vector, vb; modifies PCM vector */
676 /* only MDCT right now.... */
677 for(i=0;i<vi->channels;i++){
678 float *pcm=vb->pcm[i];
679 _analysis_output("out",seq+i,pcm,n/2,1,1);
680 _analysis_output("lout",seq+i,pcm,n/2,0,0);
681 mdct_backward(b->transform[vb->W][0],pcm,pcm);
684 /* window the data */
685 for(i=0;i<vi->channels;i++){
686 float *pcm=vb->pcm[i];
693 _analysis_output("final",seq++,pcm,n,0,0);
696 /* now apply the decoded post-window time information */
697 /* NOT IMPLEMENTED */
704 vorbis_func_mapping mapping0_exportbundle={