lib/mapping0.c

   1 /********************************************************************
   2  *                                                                  *
   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.       *
   7  *                                                                  *
   8  * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001             *
   9  * by the XIPHOPHORUS Company http://www.xiph.org/                  *
  10  *                                                                  *
  11  ********************************************************************
  12
  13  function: channel mapping 0 implementation
  14  last mod: $Id: mapping0.c,v 1.30 2001/06/15 21:15:39 xiphmont Exp $
  15
  16  ********************************************************************/
  17
  18 #include <stdlib.h>
  19 #include <stdio.h>
  20 #include <string.h>
  21 #include <math.h>
  22 #include <ogg/ogg.h>
  23 #include "vorbis/codec.h"
  24 #include "codec_internal.h"
  25 #include "codebook.h"
  26 #include "bitbuffer.h"
  27 #include "registry.h"
  28 #include "psy.h"
  29 #include "misc.h"
  30
  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
  34    off as low priority.
  35
  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 */
  39
  40 typedef struct {
  41   drft_lookup fft_look;
  42   vorbis_info_mode *mode;
  43   vorbis_info_mapping0 *map;
  44
  45   vorbis_look_time **time_look;
  46   vorbis_look_floor **floor_look;
  47
  48   vorbis_look_residue **residue_look;
  49   vorbis_look_psy *psy_look;
  50
  51   vorbis_func_time **time_func;
  52   vorbis_func_floor **floor_func;
  53   vorbis_func_residue **residue_func;
  54
  55   int ch;
  56   long lastframe; /* if a different mode is called, we need to
  57                      invalidate decay */
  58 } vorbis_look_mapping0;
  59
  60 static vorbis_info_mapping *mapping0_copy_info(vorbis_info_mapping *vm){
  61   vorbis_info_mapping0 *info=(vorbis_info_mapping0 *)vm;
  62   vorbis_info_mapping0 *ret=_ogg_malloc(sizeof(vorbis_info_mapping0));
  63   memcpy(ret,info,sizeof(vorbis_info_mapping0));
  64   return(ret);
  65 }
  66
  67 static void mapping0_free_info(vorbis_info_mapping *i){
  68   if(i){
  69     memset(i,0,sizeof(vorbis_info_mapping0));
  70     _ogg_free(i);
  71   }
  72 }
  73
  74 static void mapping0_free_look(vorbis_look_mapping *look){
  75   int i;
  76   vorbis_look_mapping0 *l=(vorbis_look_mapping0 *)look;
  77   if(l){
  78     drft_clear(&l->fft_look);
  79
  80     for(i=0;i<l->map->submaps;i++){
  81       l->time_func[i]->free_look(l->time_look[i]);
  82       l->floor_func[i]->free_look(l->floor_look[i]);
  83       l->residue_func[i]->free_look(l->residue_look[i]);
  84       if(l->psy_look)_vp_psy_clear(l->psy_look+i);
  85     }
  86
  87     _ogg_free(l->time_func);
  88     _ogg_free(l->floor_func);
  89     _ogg_free(l->residue_func);
  90     _ogg_free(l->time_look);
  91     _ogg_free(l->floor_look);
  92     _ogg_free(l->residue_look);
  93     if(l->psy_look)_ogg_free(l->psy_look);
  94     memset(l,0,sizeof(vorbis_look_mapping0));
  95     _ogg_free(l);
  96   }
  97 }
  98
  99 static vorbis_look_mapping *mapping0_look(vorbis_dsp_state *vd,vorbis_info_mode *vm,
 100                           vorbis_info_mapping *m){
 101   int i;
 102   vorbis_info          *vi=vd->vi;
 103   codec_setup_info     *ci=vi->codec_setup;
 104   vorbis_look_mapping0 *look=_ogg_calloc(1,sizeof(vorbis_look_mapping0));
 105   vorbis_info_mapping0 *info=look->map=(vorbis_info_mapping0 *)m;
 106   look->mode=vm;
 107
 108   look->time_look=_ogg_calloc(info->submaps,sizeof(vorbis_look_time *));
 109   look->floor_look=_ogg_calloc(info->submaps,sizeof(vorbis_look_floor *));
 110
 111   look->residue_look=_ogg_calloc(info->submaps,sizeof(vorbis_look_residue *));
 112   if(ci->psys)look->psy_look=_ogg_calloc(info->submaps,sizeof(vorbis_look_psy));
 113
 114   look->time_func=_ogg_calloc(info->submaps,sizeof(vorbis_func_time *));
 115   look->floor_func=_ogg_calloc(info->submaps,sizeof(vorbis_func_floor *));
 116   look->residue_func=_ogg_calloc(info->submaps,sizeof(vorbis_func_residue *));
 117
 118   for(i=0;i<info->submaps;i++){
 119     int timenum=info->timesubmap[i];
 120     int floornum=info->floorsubmap[i];
 121     int resnum=info->residuesubmap[i];
 122
 123     look->time_func[i]=_time_P[ci->time_type[timenum]];
 124     look->time_look[i]=look->time_func[i]->
 125       look(vd,vm,ci->time_param[timenum]);
 126     look->floor_func[i]=_floor_P[ci->floor_type[floornum]];
 127     look->floor_look[i]=look->floor_func[i]->
 128       look(vd,vm,ci->floor_param[floornum]);
 129     look->residue_func[i]=_residue_P[ci->residue_type[resnum]];
 130     look->residue_look[i]=look->residue_func[i]->
 131       look(vd,vm,ci->residue_param[resnum]);
 132
 133     if(ci->psys && vd->analysisp){
 134       int psynum=info->psysubmap[i];
 135       _vp_psy_init(look->psy_look+i,ci->psy_param[psynum],
 136                    ci->blocksizes[vm->blockflag]/2,vi->rate);
 137     }
 138   }
 139
 140   look->ch=vi->channels;
 141
 142   if(vd->analysisp)drft_init(&look->fft_look,ci->blocksizes[vm->blockflag]);
 143   return(look);
 144 }
 145
 146 static int ilog2(unsigned int v){
 147   int ret=0;
 148   while(v>1){
 149     ret++;
 150     v>>=1;
 151   }
 152   return(ret);
 153 }
 154
 155 static void mapping0_pack(vorbis_info *vi,vorbis_info_mapping *vm,oggpack_buffer *opb){
 156   int i;
 157   vorbis_info_mapping0 *info=(vorbis_info_mapping0 *)vm;
 158
 159   /* another 'we meant to do it this way' hack...  up to beta 4, we
 160      packed 4 binary zeros here to signify one submapping in use.  We
 161      now redefine that to mean four bitflags that indicate use of
 162      deeper features; bit0:submappings, bit1:coupling,
 163      bit2,3:reserved. This is backward compatable with all actual uses
 164      of the beta code. */
 165
 166   if(info->submaps>1){
 167     oggpack_write(opb,1,1);
 168     oggpack_write(opb,info->submaps-1,4);
 169   }else
 170     oggpack_write(opb,0,1);
 171
 172   if(info->coupling_steps>0){
 173     oggpack_write(opb,1,1);
 174     oggpack_write(opb,info->coupling_steps-1,8);
 175
 176     for(i=0;i<info->coupling_steps;i++){
 177       oggpack_write(opb,info->coupling_mag[i],ilog2(vi->channels));
 178       oggpack_write(opb,info->coupling_ang[i],ilog2(vi->channels));
 179     }
 180   }else
 181     oggpack_write(opb,0,1);
 182
 183   oggpack_write(opb,0,2); /* 2,3:reserved */
 184
 185   /* we don't write the channel submappings if we only have one... */
 186   if(info->submaps>1){
 187     for(i=0;i<vi->channels;i++)
 188       oggpack_write(opb,info->chmuxlist[i],4);
 189   }
 190   for(i=0;i<info->submaps;i++){
 191     oggpack_write(opb,info->timesubmap[i],8);
 192     oggpack_write(opb,info->floorsubmap[i],8);
 193     oggpack_write(opb,info->residuesubmap[i],8);
 194   }
 195 }
 196
 197 /* also responsible for range checking */
 198 static vorbis_info_mapping *mapping0_unpack(vorbis_info *vi,oggpack_buffer *opb){
 199   int i;
 200   vorbis_info_mapping0 *info=_ogg_calloc(1,sizeof(vorbis_info_mapping0));
 201   codec_setup_info     *ci=vi->codec_setup;
 202   memset(info,0,sizeof(vorbis_info_mapping0));
 203
 204   if(oggpack_read(opb,1))
 205     info->submaps=oggpack_read(opb,4)+1;
 206   else
 207     info->submaps=1;
 208
 209   if(oggpack_read(opb,1)){
 210     info->coupling_steps=oggpack_read(opb,8)+1;
 211
 212     for(i=0;i<info->coupling_steps;i++){
 213       int testM=info->coupling_mag[i]=oggpack_read(opb,ilog2(vi->channels));
 214       int testA=info->coupling_ang[i]=oggpack_read(opb,ilog2(vi->channels));
 215
 216       if(testM<0 ||
 217          testA<0 ||
 218          testM==testA ||
 219          testM>=vi->channels ||
 220          testA>=vi->channels) goto err_out;
 221     }
 222
 223   }
 224
 225   if(oggpack_read(opb,2)>0)goto err_out; /* 2,3:reserved */
 226
 227   if(info->submaps>1){
 228     for(i=0;i<vi->channels;i++){
 229       info->chmuxlist[i]=oggpack_read(opb,4);
 230       if(info->chmuxlist[i]>=info->submaps)goto err_out;
 231     }
 232   }
 233   for(i=0;i<info->submaps;i++){
 234     info->timesubmap[i]=oggpack_read(opb,8);
 235     if(info->timesubmap[i]>=ci->times)goto err_out;
 236     info->floorsubmap[i]=oggpack_read(opb,8);
 237     if(info->floorsubmap[i]>=ci->floors)goto err_out;
 238     info->residuesubmap[i]=oggpack_read(opb,8);
 239     if(info->residuesubmap[i]>=ci->residues)goto err_out;
 240   }
 241
 242   return info;
 243
 244  err_out:
 245   mapping0_free_info(info);
 246   return(NULL);
 247 }
 248
 249 #include "os.h"
 250 #include "lpc.h"
 251 #include "lsp.h"
 252 #include "envelope.h"
 253 #include "mdct.h"
 254 #include "psy.h"
 255 #define VORBIS_IEEE_FLOAT32
 256 #include "scales.h"
 257
 258 /* no time mapping implementation for now */
 259 static long seq=0;
 260 static int mapping0_forward(vorbis_block *vb,vorbis_look_mapping *l){
 261   vorbis_dsp_state      *vd=vb->vd;
 262   vorbis_info           *vi=vd->vi;
 263   backend_lookup_state  *b=vb->vd->backend_state;
 264   vorbis_look_mapping0  *look=(vorbis_look_mapping0 *)l;
 265   vorbis_info_mapping0  *info=look->map;
 266   vorbis_info_mode      *mode=look->mode;
 267   vorbis_block_internal *vbi=(vorbis_block_internal *)vb->internal;
 268   int                    n=vb->pcmend;
 269   int i,j;
 270   float *window=b->window[vb->W][vb->lW][vb->nW][mode->windowtype];
 271
 272   float **pcmbundle=alloca(sizeof(float *)*vi->channels);
 273
 274   int    *nonzero=alloca(sizeof(int)*vi->channels);
 275
 276   float *work=_vorbis_block_alloc(vb,n*sizeof(float));
 277   float newmax=vbi->ampmax;
 278
 279   for(i=0;i<vi->channels;i++){
 280     float scale=4.f/n;
 281     int submap=info->chmuxlist[i];
 282     float ret;
 283
 284     /* the following makes things clearer to *me* anyway */
 285     float *pcm     =vb->pcm[i];
 286     float *mdct    =pcm;
 287     float *logmdct =pcm+n/2;
 288     float *res     =pcm;
 289     float *codedflr=pcm+n/2;
 290     float *fft     =work;
 291     float *logfft  =work;
 292     float *logmax  =work;
 293     float *logmask =work+n/2;
 294
 295     /* window the PCM data */
 296     for(j=0;j<n;j++)
 297       fft[j]=pcm[j]*=window[j];
 298
 299     /* transform the PCM data */
 300     /* only MDCT right now.... */
 301     mdct_forward(b->transform[vb->W][0],pcm,pcm);
 302     for(j=0;j<n/2;j++)
 303       logmdct[j]=todB(mdct+j);
 304
 305     /* FFT yields more accurate tonal estimation (not phase sensitive) */
 306     drft_forward(&look->fft_look,fft);
 307     fft[0]*=scale;
 308     fft[0]=todB(fft);
 309     for(j=1;j<n-1;j+=2){
 310       float temp=scale*FAST_HYPOT(fft[j],fft[j+1]);
 311       logfft[(j+1)>>1]=todB(&temp);
 312     }
 313
 314     _analysis_output("fft",seq,logfft,n/2,0,0);
 315     _analysis_output("mdct",seq,logmdct,n/2,0,0);
 316
 317     /* perform psychoacoustics; do masking */
 318     ret=_vp_compute_mask(look->psy_look+submap,
 319                          logfft, /* -> logmax */
 320                          logmdct,
 321                          logmask,
 322                          vbi->ampmax);
 323     if(ret>newmax)newmax=ret;
 324
 325     _analysis_output("mask",seq,logmask,n/2,0,0);
 326
 327     /* perform floor encoding */
 328     nonzero[i]=look->floor_func[submap]->
 329       forward(vb,look->floor_look[submap],
 330               mdct,
 331               logmdct,
 332               logmask,
 333               logmax,
 334               res,
 335               codedflr);
 336
 337     for(j=0;j<n/2;j++)
 338       if(fabs(vb->pcm[i][j]>1000))
 339         fprintf(stderr,"%ld ",seq);
 340
 341     _analysis_output("res",seq-vi->channels+j,vb->pcm[i],n,0,0);
 342     _analysis_output("codedflr",seq++,codedflr,n/2,0,1);
 343
 344   }
 345
 346   vbi->ampmax=newmax;
 347
 348   /* channel coupling */
 349   for(i=0;i<info->coupling_steps;i++){
 350     float *pcmM=vb->pcm[info->coupling_mag[i]];
 351     float *pcmA=vb->pcm[info->coupling_ang[i]];
 352
 353     /*     +-
 354             B
 355             |       A-B
 356      -4 -3 -2 -1  0
 357             |
 358       3     |     1
 359             |
 360   -+  2-----+-----2----A ++
 361             |
 362       1     |     3
 363             |
 364       0 -1 -2 -3 -4
 365   B-A       |
 366            --
 367
 368     */
 369     for(j=n/2-1;j>=0;j--){
 370       float A=rint(pcmM[j]);
 371       float B=rint(pcmA[j]);
 372
 373       if(fabs(A)>fabs(B)){
 374         pcmM[j]=A;
 375         if(A>0)
 376           pcmA[j]=A-B;
 377         else
 378           pcmA[j]=B-A;
 379       }else{
 380         pcmM[j]=B;
 381         if(B>0)
 382           pcmA[j]=A-B;
 383         else
 384           pcmA[j]=B-A;
 385       }
 386
 387       /*if(fabs(mag)<3.5f)
 388         ang=rint(ang/(mag*2.f))*mag*2.f;*/
 389
 390       /*if(fabs(mag)<1.5)
 391         ang=0;*/
 392
 393       /*if(i>(n*3/16))
 394         ang=0;*/
 395
 396       /*if(ang>=fabs(mag*2))ang=-fabs(mag*2);*/
 397     }
 398   }
 399
 400   /* perform residue encoding with residue mapping; this is
 401      multiplexed.  All the channels belonging to one submap are
 402      encoded (values interleaved), then the next submap, etc */
 403
 404   for(i=0;i<info->submaps;i++){
 405     int ch_in_bundle=0;
 406     for(j=0;j<vi->channels;j++){
 407       if(info->chmuxlist[j]==i && nonzero[j])
 408         pcmbundle[ch_in_bundle++]=vb->pcm[j];
 409
 410     }
 411
 412     look->residue_func[i]->forward(vb,look->residue_look[i],
 413                                    pcmbundle,ch_in_bundle);
 414   }
 415
 416   look->lastframe=vb->sequence;
 417   return(0);
 418 }
 419
 420 static int mapping0_inverse(vorbis_block *vb,vorbis_look_mapping *l){
 421   vorbis_dsp_state     *vd=vb->vd;
 422   vorbis_info          *vi=vd->vi;
 423   codec_setup_info     *ci=vi->codec_setup;
 424   backend_lookup_state *b=vd->backend_state;
 425   vorbis_look_mapping0 *look=(vorbis_look_mapping0 *)l;
 426   vorbis_info_mapping0 *info=look->map;
 427   vorbis_info_mode     *mode=look->mode;
 428   int                   i,j;
 429   long                  n=vb->pcmend=ci->blocksizes[vb->W];
 430
 431   float *window=b->window[vb->W][vb->lW][vb->nW][mode->windowtype];
 432   float **pcmbundle=alloca(sizeof(float *)*vi->channels);
 433   void **nonzero=alloca(sizeof(void *)*vi->channels);
 434
 435   /* time domain information decode (note that applying the
 436      information would have to happen later; we'll probably add a
 437      function entry to the harness for that later */
 438   /* NOT IMPLEMENTED */
 439
 440   /* recover the spectral envelope; store it in the PCM vector for now */
 441   for(i=0;i<vi->channels;i++){
 442     int submap=info->chmuxlist[i];
 443     nonzero[i]=look->floor_func[submap]->
 444       inverse1(vb,look->floor_look[submap]);
 445     memset(vb->pcm[i],0,sizeof(float)*n/2);
 446   }
 447
 448   /* recover the residue into our working vectors */
 449
 450   for(i=0;i<info->submaps;i++){
 451     int ch_in_bundle=0;
 452     for(j=0;j<vi->channels;j++){
 453       if(info->chmuxlist[j]==i && nonzero[j])
 454         pcmbundle[ch_in_bundle++]=vb->pcm[j];
 455     }
 456
 457     look->residue_func[i]->inverse(vb,look->residue_look[i],pcmbundle,ch_in_bundle);
 458   }
 459
 460   /* channel coupling */
 461   for(i=info->coupling_steps-1;i>=0;i--){
 462     float *pcmM=vb->pcm[info->coupling_mag[i]];
 463     float *pcmA=vb->pcm[info->coupling_ang[i]];
 464
 465     for(j=0;j<n/2;j++){
 466       float mag=pcmM[j];
 467       float ang=pcmA[j];
 468
 469       if(mag>0)
 470         if(ang>0){
 471           pcmM[j]=mag;
 472           pcmA[j]=mag-ang;
 473         }else{
 474           pcmA[j]=mag;
 475           pcmM[j]=mag+ang;
 476         }
 477       else
 478         if(ang>0){
 479           pcmM[j]=mag;
 480           pcmA[j]=mag+ang;
 481         }else{
 482           pcmA[j]=mag;
 483           pcmM[j]=mag-ang;
 484         }
 485     }
 486   }
 487
 488   /* compute and apply spectral envelope */
 489   for(i=0;i<vi->channels;i++){
 490     float *pcm=vb->pcm[i];
 491     int submap=info->chmuxlist[i];
 492     look->floor_func[submap]->
 493       inverse2(vb,look->floor_look[submap],nonzero[i],pcm);
 494   }
 495
 496   /* transform the PCM data; takes PCM vector, vb; modifies PCM vector */
 497   /* only MDCT right now.... */
 498   for(i=0;i<vi->channels;i++){
 499     float *pcm=vb->pcm[i];
 500     _analysis_output("out",seq+i,pcm,n/2,0,1);
 501     mdct_backward(b->transform[vb->W][0],pcm,pcm);
 502   }
 503
 504   /* window the data */
 505   for(i=0;i<vi->channels;i++){
 506     float *pcm=vb->pcm[i];
 507     if(nonzero[i])
 508       for(j=0;j<n;j++)
 509         pcm[j]*=window[j];
 510     else
 511       for(j=0;j<n;j++)
 512         pcm[j]=0.f;
 513     _analysis_output("final",seq++,pcm,n,0,0);
 514   }
 515
 516   /* now apply the decoded post-window time information */
 517   /* NOT IMPLEMENTED */
 518
 519   /* all done! */
 520   return(0);
 521 }
 522
 523 /* export hooks */
 524 vorbis_func_mapping mapping0_exportbundle={
 525   &mapping0_pack,&mapping0_unpack,&mapping0_look,&mapping0_copy_info,
 526   &mapping0_free_info,&mapping0_free_look,&mapping0_forward,&mapping0_inverse
 527 };