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: channel mapping 0 implementation
14 last mod: $Id: mapping0.c,v 1.44 2002/01/22 11:59:00 xiphmont Exp $
16 ********************************************************************/
23 #include "vorbis/codec.h"
24 #include "codec_internal.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,
183 oggpack_buffer *opb){
185 vorbis_info_mapping0 *info=(vorbis_info_mapping0 *)vm;
187 /* another 'we meant to do it this way' hack... up to beta 4, we
188 packed 4 binary zeros here to signify one submapping in use. We
189 now redefine that to mean four bitflags that indicate use of
190 deeper features; bit0:submappings, bit1:coupling,
191 bit2,3:reserved. This is backward compatable with all actual uses
195 oggpack_write(opb,1,1);
196 oggpack_write(opb,info->submaps-1,4);
198 oggpack_write(opb,0,1);
200 if(info->coupling_steps>0){
201 oggpack_write(opb,1,1);
202 oggpack_write(opb,info->coupling_steps-1,8);
204 for(i=0;i<info->coupling_steps;i++){
205 oggpack_write(opb,info->coupling_mag[i],ilog2(vi->channels));
206 oggpack_write(opb,info->coupling_ang[i],ilog2(vi->channels));
209 oggpack_write(opb,0,1);
211 oggpack_write(opb,0,2); /* 2,3:reserved */
213 /* we don't write the channel submappings if we only have one... */
215 for(i=0;i<vi->channels;i++)
216 oggpack_write(opb,info->chmuxlist[i],4);
218 for(i=0;i<info->submaps;i++){
219 oggpack_write(opb,info->timesubmap[i],8);
220 oggpack_write(opb,info->floorsubmap[i],8);
221 oggpack_write(opb,info->residuesubmap[i],8);
225 /* also responsible for range checking */
226 static vorbis_info_mapping *mapping0_unpack(vorbis_info *vi,oggpack_buffer *opb){
228 vorbis_info_mapping0 *info=_ogg_calloc(1,sizeof(*info));
229 codec_setup_info *ci=vi->codec_setup;
230 memset(info,0,sizeof(*info));
232 if(oggpack_read(opb,1))
233 info->submaps=oggpack_read(opb,4)+1;
237 if(oggpack_read(opb,1)){
238 info->coupling_steps=oggpack_read(opb,8)+1;
240 for(i=0;i<info->coupling_steps;i++){
241 int testM=info->coupling_mag[i]=oggpack_read(opb,ilog2(vi->channels));
242 int testA=info->coupling_ang[i]=oggpack_read(opb,ilog2(vi->channels));
247 testM>=vi->channels ||
248 testA>=vi->channels) goto err_out;
253 if(oggpack_read(opb,2)>0)goto err_out; /* 2,3:reserved */
256 for(i=0;i<vi->channels;i++){
257 info->chmuxlist[i]=oggpack_read(opb,4);
258 if(info->chmuxlist[i]>=info->submaps)goto err_out;
261 for(i=0;i<info->submaps;i++){
262 info->timesubmap[i]=oggpack_read(opb,8);
263 if(info->timesubmap[i]>=ci->times)goto err_out;
264 info->floorsubmap[i]=oggpack_read(opb,8);
265 if(info->floorsubmap[i]>=ci->floors)goto err_out;
266 info->residuesubmap[i]=oggpack_read(opb,8);
267 if(info->residuesubmap[i]>=ci->residues)goto err_out;
273 mapping0_free_info(info);
280 #include "envelope.h"
285 /* no time mapping implementation for now */
287 static int mapping0_forward(vorbis_block *vb,vorbis_look_mapping *l){
288 vorbis_dsp_state *vd=vb->vd;
289 vorbis_info *vi=vd->vi;
290 codec_setup_info *ci=vi->codec_setup;
291 backend_lookup_state *b=vb->vd->backend_state;
292 bitrate_manager_state *bm=&b->bms;
293 vorbis_look_mapping0 *look=(vorbis_look_mapping0 *)l;
294 vorbis_info_mapping0 *info=look->map;
295 vorbis_info_mode *mode=look->mode;
296 vorbis_block_internal *vbi=(vorbis_block_internal *)vb->internal;
299 int *nonzero=alloca(sizeof(*nonzero)*vi->channels);
301 float *work=_vorbis_block_alloc(vb,n*sizeof(*work));
303 float global_ampmax=vbi->ampmax;
304 float *local_ampmax=alloca(sizeof(*local_ampmax)*vi->channels);
305 int blocktype=vbi->blocktype;
307 /* we differentiate between short and long block types to help the
308 masking engine; the window shapes also matter.
309 impulse block (a short block in which an impulse occurs)
310 padding block (a short block that pads between a transitional
311 long block and an impulse block, or vice versa)
312 transition block (the wqeird one; a long block with the transition
313 window; affects bass/midrange response and that must be
314 accounted for in masking)
315 long block (run of the mill long block)
318 for(i=0;i<vi->channels;i++){
322 /* the following makes things clearer to *me* anyway */
323 float *pcm =vb->pcm[i];
325 float *logfft =pcm+n/2;
329 float *codedflr=pcm+n/2;
331 float *logmask =work+n/2;*/
333 scale_dB=todB(&scale);
334 _analysis_output("pcm",seq+i,pcm,n,0,0);
336 /* window the PCM data */
337 _vorbis_apply_window(pcm,b->window,ci->blocksizes,vb->lW,vb->W,vb->nW);
338 memcpy(fft,pcm,sizeof(*fft)*n);
340 /*_analysis_output("windowed",seq+i,pcm,n,0,0);*/
342 /* transform the PCM data */
343 /* only MDCT right now.... */
344 mdct_forward(b->transform[vb->W][0],pcm,pcm);
346 /* FFT yields more accurate tonal estimation (not phase sensitive) */
347 drft_forward(&look->fft_look,fft);
350 local_ampmax[i]=logfft[0];
352 float temp=fft[j]*fft[j]+fft[j+1]*fft[j+1];
353 temp=logfft[(j+1)>>1]=scale_dB+.5f*todB(&temp);
354 if(temp>local_ampmax[i])local_ampmax[i]=temp;
357 if(local_ampmax[i]>0.f)local_ampmax[i]=0.f;
358 if(local_ampmax[i]>global_ampmax)global_ampmax=local_ampmax[i];
360 _analysis_output("fft",seq+i,logfft,n/2,1,0);
363 for(i=0;i<vi->channels;i++){
364 int submap=info->chmuxlist[i];
366 /* the following makes things clearer to *me* anyway */
367 float *mdct =vb->pcm[i];
369 float *codedflr=mdct+n/2;
370 float *logfft =mdct+n/2;
372 float *logmdct =work;
373 float *logmax =mdct+n/2;
374 float *logmask =work+n/2;
377 logmdct[j]=todB(mdct+j);
378 _analysis_output("mdct",seq+i,logmdct,n/2,1,0);
381 /* perform psychoacoustics; do masking */
382 _vp_compute_mask(look->psy_look[blocktype],
383 logfft, /* -> logmax */
390 _analysis_output("mask",seq+i,logmask,n/2,1,0);
391 /* perform floor encoding */
392 nonzero[i]=look->floor_func[submap]->
393 forward(vb,look->floor_look[submap],
402 _vp_remove_floor(look->psy_look[blocktype],
408 if(fabs(res[j])>1200){
410 fprintf(stderr,"%ld ",seq+i);
413 _analysis_output("codedflr",seq+i,codedflr,n/2,1,1);
417 vbi->ampmax=global_ampmax;
419 /* partition based prequantization and channel coupling */
420 /* Steps in prequant and coupling:
422 classify by |mag| across all pcm vectors
424 down-couple/down-quantize from perfect residue -> quantized vector
427 encode quantized vector; add encoded values to 'so-far' vector
428 more? [not yet at bitrate/not yet at target]
430 down-couple/down-quantize from perfect-'so-far' ->
431 quantized vector; when subtracting coupling,
432 account for +/- out-of-phase component
439 quantization in each iteration is done (after circular normalization
440 in coupling) using a by-iteration quantization granule value.
445 float **quantized=alloca(sizeof(*quantized)*vi->channels);
446 float **sofar=alloca(sizeof(*sofar)*vi->channels);
448 long ***classifications=alloca(sizeof(*classifications)*info->submaps);
449 float ***qbundle=alloca(sizeof(*qbundle)*info->submaps);
450 float ***pcmbundle=alloca(sizeof(*pcmbundle)*info->submaps);
451 float ***sobundle=alloca(sizeof(*sobundle)*info->submaps);
452 int **zerobundle=alloca(sizeof(*zerobundle)*info->submaps);
453 int *chbundle=alloca(sizeof(*chbundle)*info->submaps);
456 /* play a little loose with this abstraction */
457 int quant_passes=ci->coupling_passes;
459 for(i=0;i<vi->channels;i++){
460 quantized[i]=_vorbis_block_alloc(vb,n*sizeof(*sofar[i]));
461 sofar[i]=quantized[i]+n/2;
462 memset(sofar[i],0,sizeof(*sofar[i])*n/2);
465 qbundle[0]=alloca(sizeof(*qbundle[0])*vi->channels);
466 pcmbundle[0]=alloca(sizeof(*pcmbundle[0])*vi->channels);
467 sobundle[0]=alloca(sizeof(*sobundle[0])*vi->channels);
468 zerobundle[0]=alloca(sizeof(*zerobundle[0])*vi->channels);
470 /* initial down-quantized coupling */
472 if(info->coupling_steps==0){
473 /* this assumes all or nothing coupling right now. it should pass
474 through any channels left uncoupled, but it doesn't do that now */
475 for(i=0;i<vi->channels;i++){
477 float *lqua=quantized[i];
482 _vp_quantize_couple(look->psy_look[blocktype],
491 for(i=0;i<vi->channels;i++)
492 _analysis_output("quant",seq+i,quantized[i],n/2,1,0);
495 /* classify, by submap */
497 for(i=0;i<info->submaps;i++){
499 qbundle[i]=qbundle[0]+chcounter;
500 sobundle[i]=sobundle[0]+chcounter;
501 zerobundle[i]=zerobundle[0]+chcounter;
503 for(j=0;j<vi->channels;j++){
504 if(info->chmuxlist[j]==i){
506 zerobundle[i][ch_in_bundle]=1;
508 zerobundle[i][ch_in_bundle]=0;
509 qbundle[i][ch_in_bundle]=quantized[j];
510 pcmbundle[i][ch_in_bundle]=pcm[j];
511 sobundle[i][ch_in_bundle++]=sofar[j];
514 chbundle[i]=ch_in_bundle;
515 chcounter+=ch_in_bundle;
517 classifications[i]=look->residue_func[i]->
518 class(vb,look->residue_look[i],pcmbundle[i],zerobundle[i],chbundle[i]);
521 /* actual encoding loop; we pack all the iterations to collect
524 for(i=0;i<quant_passes;){
526 /* perform residue encoding of this pass's quantized residue
527 vector, according residue mapping */
529 for(j=0;j<info->submaps;j++){
530 look->residue_func[j]->
531 forward(vb,look->residue_look[j],
532 qbundle[j],sobundle[j],zerobundle[j],chbundle[j],
533 i,classifications[j],vbi->packet_markers);
539 /* down-couple/down-quantize from perfect-'so-far' ->
540 new quantized vector */
541 if(info->coupling_steps==0){
542 /* this assumes all or nothing coupling right now. it should pass
543 through any channels left uncoupled, but it doesn't do that now */
545 for(k=0;k<vi->channels;k++){
547 float *lsof=sofar[k];
548 float *lqua=quantized[k];
550 lqua[j]=lpcm[j]-lsof[j];
554 _vp_quantize_couple(look->psy_look[blocktype],
567 look->lastframe=vb->sequence;
571 static int mapping0_inverse(vorbis_block *vb,vorbis_look_mapping *l){
572 vorbis_dsp_state *vd=vb->vd;
573 vorbis_info *vi=vd->vi;
574 codec_setup_info *ci=vi->codec_setup;
575 backend_lookup_state *b=vd->backend_state;
576 vorbis_look_mapping0 *look=(vorbis_look_mapping0 *)l;
577 vorbis_info_mapping0 *info=look->map;
578 vorbis_info_mode *mode=look->mode;
580 long n=vb->pcmend=ci->blocksizes[vb->W];
582 float **pcmbundle=alloca(sizeof(*pcmbundle)*vi->channels);
583 int *zerobundle=alloca(sizeof(*zerobundle)*vi->channels);
585 int *nonzero =alloca(sizeof(*nonzero)*vi->channels);
586 void **floormemo=alloca(sizeof(*floormemo)*vi->channels);
588 /* time domain information decode (note that applying the
589 information would have to happen later; we'll probably add a
590 function entry to the harness for that later */
591 /* NOT IMPLEMENTED */
593 /* recover the spectral envelope; store it in the PCM vector for now */
594 for(i=0;i<vi->channels;i++){
595 int submap=info->chmuxlist[i];
596 floormemo[i]=look->floor_func[submap]->
597 inverse1(vb,look->floor_look[submap]);
602 memset(vb->pcm[i],0,sizeof(*vb->pcm[i])*n/2);
605 /* channel coupling can 'dirty' the nonzero listing */
606 for(i=0;i<info->coupling_steps;i++){
607 if(nonzero[info->coupling_mag[i]] ||
608 nonzero[info->coupling_ang[i]]){
609 nonzero[info->coupling_mag[i]]=1;
610 nonzero[info->coupling_ang[i]]=1;
614 /* recover the residue into our working vectors */
615 for(i=0;i<info->submaps;i++){
617 for(j=0;j<vi->channels;j++){
618 if(info->chmuxlist[j]==i){
620 zerobundle[ch_in_bundle]=1;
622 zerobundle[ch_in_bundle]=0;
623 pcmbundle[ch_in_bundle++]=vb->pcm[j];
627 look->residue_func[i]->inverse(vb,look->residue_look[i],
628 pcmbundle,zerobundle,ch_in_bundle);
631 /* channel coupling */
632 for(i=info->coupling_steps-1;i>=0;i--){
633 float *pcmM=vb->pcm[info->coupling_mag[i]];
634 float *pcmA=vb->pcm[info->coupling_ang[i]];
659 /* compute and apply spectral envelope */
660 for(i=0;i<vi->channels;i++){
661 float *pcm=vb->pcm[i];
662 int submap=info->chmuxlist[i];
663 look->floor_func[submap]->
664 inverse2(vb,look->floor_look[submap],floormemo[i],pcm);
667 /* transform the PCM data; takes PCM vector, vb; modifies PCM vector */
668 /* only MDCT right now.... */
669 for(i=0;i<vi->channels;i++){
670 float *pcm=vb->pcm[i];
671 mdct_backward(b->transform[vb->W][0],pcm,pcm);
674 /* window the data */
675 for(i=0;i<vi->channels;i++){
676 float *pcm=vb->pcm[i];
678 _vorbis_apply_window(pcm,b->window,ci->blocksizes,vb->lW,vb->W,vb->nW);
690 vorbis_func_mapping mapping0_exportbundle={