plugins/dfsound/reverb.c

   1 /***************************************************************************\r
   2                           reverb.c  -  description\r
   3                              -------------------\r
   4     begin                : Wed May 15 2002\r
   5     copyright            : (C) 2002 by Pete Bernert\r
   6     email                : BlackDove@addcom.de\r
   7 \r
   8  Portions (C) Gražvydas "notaz" Ignotas, 2010-2011\r
   9  Portions (C) SPU2-X, gigaherz, Pcsx2 Development Team\r
  10 \r
  11  ***************************************************************************/\r
  12 /***************************************************************************\r
  13  *                                                                         *\r
  14  *   This program is free software; you can redistribute it and/or modify  *\r
  15  *   it under the terms of the GNU General Public License as published by  *\r
  16  *   the Free Software Foundation; either version 2 of the License, or     *\r
  17  *   (at your option) any later version. See also the license.txt file for *\r
  18  *   additional informations.                                              *\r
  19  *                                                                         *\r
  20  ***************************************************************************/\r
  21 \r
  22 #include "stdafx.h"\r
  23 \r
  24 #define _IN_REVERB\r
  25 \r
  26 // will be included from spu.c\r
  27 #ifdef _IN_SPU\r
  28 \r
  29 ////////////////////////////////////////////////////////////////////////\r
  30 // START REVERB\r
  31 ////////////////////////////////////////////////////////////////////////\r
  32 \r
  33 INLINE void StartREVERB(int ch)\r
  34 {\r
  35  if(spu.s_chan[ch].bReverb && (spu.spuCtrl&0x80))      // reverb possible?\r
  36   {\r
  37    spu.s_chan[ch].bRVBActive=!!spu_config.iUseReverb;\r
  38   }\r
  39  else spu.s_chan[ch].bRVBActive=0;                     // else -> no reverb\r
  40 }\r
  41 \r
  42 ////////////////////////////////////////////////////////////////////////\r
  43 \r
  44 INLINE int rvb2ram_offs(int curr, int space, int iOff)\r
  45 {\r
  46  iOff += curr;\r
  47  if (iOff >= 0x40000) iOff -= space;\r
  48  return iOff;\r
  49 }\r
  50 \r
  51 // get_buffer content helper: takes care about wraps\r
  52 #define g_buffer(var) \\r
  53  ((int)(signed short)spu.spuMem[rvb2ram_offs(curr_addr, space, rvb->var)])\r
  54 \r
  55 // saturate iVal and store it as var\r
  56 #define s_buffer(var, iVal) \\r
  57  ssat32_to_16(iVal); \\r
  58  spu.spuMem[rvb2ram_offs(curr_addr, space, rvb->var)] = iVal\r
  59 \r
  60 #define s_buffer1(var, iVal) \\r
  61  ssat32_to_16(iVal); \\r
  62  spu.spuMem[rvb2ram_offs(curr_addr, space, rvb->var + 1)] = iVal\r
  63 \r
  64 ////////////////////////////////////////////////////////////////////////\r
  65 \r
  66 // portions based on spu2-x from PCSX2\r
  67 static void MixREVERB(int *SSumLR, int *RVB, int ns_to, int curr_addr)\r
  68 {\r
  69  const REVERBInfo *rvb = spu.rvb;\r
  70  int IIR_ALPHA = rvb->IIR_ALPHA;\r
  71  int IIR_COEF = rvb->IIR_COEF;\r
  72  int space = 0x40000 - rvb->StartAddr;\r
  73  int l, r, ns;\r
  74 \r
  75  for (ns = 0; ns < ns_to * 2; )\r
  76   {\r
  77    int ACC0, ACC1, FB_A0, FB_A1, FB_B0, FB_B1;\r
  78    int mix_dest_a0, mix_dest_a1, mix_dest_b0, mix_dest_b1;\r
  79 \r
  80    int input_L = RVB[ns]   * rvb->IN_COEF_L;\r
  81    int input_R = RVB[ns+1] * rvb->IN_COEF_R;\r
  82 \r
  83    int IIR_INPUT_A0 = ((g_buffer(IIR_SRC_A0) * IIR_COEF) + input_L) >> 15;\r
  84    int IIR_INPUT_A1 = ((g_buffer(IIR_SRC_A1) * IIR_COEF) + input_R) >> 15;\r
  85    int IIR_INPUT_B0 = ((g_buffer(IIR_SRC_B0) * IIR_COEF) + input_L) >> 15;\r
  86    int IIR_INPUT_B1 = ((g_buffer(IIR_SRC_B1) * IIR_COEF) + input_R) >> 15;\r
  87 \r
  88    int iir_dest_a0 = g_buffer(IIR_DEST_A0);\r
  89    int iir_dest_a1 = g_buffer(IIR_DEST_A1);\r
  90    int iir_dest_b0 = g_buffer(IIR_DEST_B0);\r
  91    int iir_dest_b1 = g_buffer(IIR_DEST_B1);\r
  92 \r
  93    int IIR_A0 = iir_dest_a0 + ((IIR_INPUT_A0 - iir_dest_a0) * IIR_ALPHA >> 15);\r
  94    int IIR_A1 = iir_dest_a1 + ((IIR_INPUT_A1 - iir_dest_a1) * IIR_ALPHA >> 15);\r
  95    int IIR_B0 = iir_dest_b0 + ((IIR_INPUT_B0 - iir_dest_b0) * IIR_ALPHA >> 15);\r
  96    int IIR_B1 = iir_dest_b1 + ((IIR_INPUT_B1 - iir_dest_b1) * IIR_ALPHA >> 15);\r
  97 \r
  98    preload(SSumLR + ns + 64*2/4 - 4);\r
  99 \r
 100    s_buffer1(IIR_DEST_A0, IIR_A0);\r
 101    s_buffer1(IIR_DEST_A1, IIR_A1);\r
 102    s_buffer1(IIR_DEST_B0, IIR_B0);\r
 103    s_buffer1(IIR_DEST_B1, IIR_B1);\r
 104 \r
 105    preload(RVB + ns + 64*2/4 - 4);\r
 106 \r
 107    ACC0 = (g_buffer(ACC_SRC_A0) * rvb->ACC_COEF_A +\r
 108            g_buffer(ACC_SRC_B0) * rvb->ACC_COEF_B +\r
 109            g_buffer(ACC_SRC_C0) * rvb->ACC_COEF_C +\r
 110            g_buffer(ACC_SRC_D0) * rvb->ACC_COEF_D) >> 15;\r
 111    ACC1 = (g_buffer(ACC_SRC_A1) * rvb->ACC_COEF_A +\r
 112            g_buffer(ACC_SRC_B1) * rvb->ACC_COEF_B +\r
 113            g_buffer(ACC_SRC_C1) * rvb->ACC_COEF_C +\r
 114            g_buffer(ACC_SRC_D1) * rvb->ACC_COEF_D) >> 15;\r
 115 \r
 116    FB_A0 = g_buffer(FB_SRC_A0);\r
 117    FB_A1 = g_buffer(FB_SRC_A1);\r
 118    FB_B0 = g_buffer(FB_SRC_B0);\r
 119    FB_B1 = g_buffer(FB_SRC_B1);\r
 120 \r
 121    mix_dest_a0 = ACC0 - ((FB_A0 * rvb->FB_ALPHA) >> 15);\r
 122    mix_dest_a1 = ACC1 - ((FB_A1 * rvb->FB_ALPHA) >> 15);\r
 123 \r
 124    mix_dest_b0 = FB_A0 + (((ACC0 - FB_A0) * rvb->FB_ALPHA - FB_B0 * rvb->FB_X) >> 15);\r
 125    mix_dest_b1 = FB_A1 + (((ACC1 - FB_A1) * rvb->FB_ALPHA - FB_B1 * rvb->FB_X) >> 15);\r
 126 \r
 127    s_buffer(MIX_DEST_A0, mix_dest_a0);\r
 128    s_buffer(MIX_DEST_A1, mix_dest_a1);\r
 129    s_buffer(MIX_DEST_B0, mix_dest_b0);\r
 130    s_buffer(MIX_DEST_B1, mix_dest_b1);\r
 131 \r
 132    l = (mix_dest_a0 + mix_dest_b0) / 2;\r
 133    r = (mix_dest_a1 + mix_dest_b1) / 2;\r
 134 \r
 135    l = (l * rvb->VolLeft)  >> 15; // 15?\r
 136    r = (r * rvb->VolRight) >> 15;\r
 137 \r
 138    SSumLR[ns++] += l;\r
 139    SSumLR[ns++] += r;\r
 140    SSumLR[ns++] += l;\r
 141    SSumLR[ns++] += r;\r
 142 \r
 143    curr_addr++;\r
 144    if (curr_addr >= 0x40000) curr_addr = rvb->StartAddr;\r
 145   }\r
 146 }\r
 147 \r
 148 static void MixREVERB_off(int *SSumLR, int ns_to, int curr_addr)\r
 149 {\r
 150  const REVERBInfo *rvb = spu.rvb;\r
 151  int space = 0x40000 - rvb->StartAddr;\r
 152  int l, r, ns;\r
 153 \r
 154  for (ns = 0; ns < ns_to * 2; )\r
 155   {\r
 156    preload(SSumLR + ns + 64*2/4 - 4);\r
 157 \r
 158    l = (g_buffer(MIX_DEST_A0) + g_buffer(MIX_DEST_B0)) / 2;\r
 159    r = (g_buffer(MIX_DEST_A1) + g_buffer(MIX_DEST_B1)) / 2;\r
 160 \r
 161    l = (l * rvb->VolLeft)  >> 15;\r
 162    r = (r * rvb->VolRight) >> 15;\r
 163 \r
 164    SSumLR[ns++] += l;\r
 165    SSumLR[ns++] += r;\r
 166    SSumLR[ns++] += l;\r
 167    SSumLR[ns++] += r;\r
 168 \r
 169    curr_addr++;\r
 170    if (curr_addr >= 0x40000) curr_addr = rvb->StartAddr;\r
 171   }\r
 172 }\r
 173 \r
 174 static void REVERBPrep(void)\r
 175 {\r
 176  REVERBInfo *rvb = spu.rvb;\r
 177  int space, t;\r
 178 \r
 179  t = spu.regArea[(H_SPUReverbAddr - 0xc00) >> 1];\r
 180  if (t == 0xFFFF || t <= 0x200)\r
 181   spu.rvb->StartAddr = spu.rvb->CurrAddr = 0;\r
 182  else if (spu.rvb->StartAddr != (t << 2))\r
 183   spu.rvb->StartAddr = spu.rvb->CurrAddr = t << 2;\r
 184 \r
 185  space = 0x40000 - rvb->StartAddr;\r
 186 \r
 187  #define prep_offs(v, r) \\r
 188    t = spu.regArea[(0x1c0 + r) >> 1] * 4; \\r
 189    while (t >= space) \\r
 190      t -= space; \\r
 191    rvb->v = t\r
 192  #define prep_offs2(d, r1, r2) \\r
 193    t = spu.regArea[(0x1c0 + r1) >> 1] * 4; \\r
 194    t -= spu.regArea[(0x1c0 + r2) >> 1] * 4; \\r
 195    while (t < 0) \\r
 196      t += space; \\r
 197    while (t >= space) \\r
 198      t -= space; \\r
 199    rvb->d = t\r
 200 \r
 201  prep_offs(IIR_SRC_A0, 32);\r
 202  prep_offs(IIR_SRC_A1, 34);\r
 203  prep_offs(IIR_SRC_B0, 36);\r
 204  prep_offs(IIR_SRC_B1, 38);\r
 205  prep_offs(IIR_DEST_A0, 20);\r
 206  prep_offs(IIR_DEST_A1, 22);\r
 207  prep_offs(IIR_DEST_B0, 36);\r
 208  prep_offs(IIR_DEST_B1, 38);\r
 209  prep_offs(ACC_SRC_A0, 24);\r
 210  prep_offs(ACC_SRC_A1, 26);\r
 211  prep_offs(ACC_SRC_B0, 28);\r
 212  prep_offs(ACC_SRC_B1, 30);\r
 213  prep_offs(ACC_SRC_C0, 40);\r
 214  prep_offs(ACC_SRC_C1, 42);\r
 215  prep_offs(ACC_SRC_D0, 44);\r
 216  prep_offs(ACC_SRC_D1, 46);\r
 217  prep_offs(MIX_DEST_A0, 52);\r
 218  prep_offs(MIX_DEST_A1, 54);\r
 219  prep_offs(MIX_DEST_B0, 56);\r
 220  prep_offs(MIX_DEST_B1, 58);\r
 221  prep_offs2(FB_SRC_A0, 52, 0);\r
 222  prep_offs2(FB_SRC_A1, 54, 0);\r
 223  prep_offs2(FB_SRC_B0, 56, 2);\r
 224  prep_offs2(FB_SRC_B1, 58, 2);\r
 225 \r
 226 #undef prep_offs\r
 227 #undef prep_offs2\r
 228  rvb->dirty = 0;\r
 229 }\r
 230 \r
 231 INLINE void REVERBDo(int *SSumLR, int *RVB, int ns_to, int curr_addr)\r
 232 {\r
 233  if (spu.spuCtrl & 0x80)                               // -> reverb on? oki\r
 234  {\r
 235   MixREVERB(SSumLR, RVB, ns_to, curr_addr);\r
 236  }\r
 237  else if (spu.rvb->VolLeft || spu.rvb->VolRight)\r
 238  {\r
 239   MixREVERB_off(SSumLR, ns_to, curr_addr);\r
 240  }\r
 241 }\r
 242 \r
 243 ////////////////////////////////////////////////////////////////////////\r
 244 \r
 245 #endif\r
 246 \r
 247 /*\r
 248 -----------------------------------------------------------------------------\r
 249 PSX reverb hardware notes\r
 250 by Neill Corlett\r
 251 -----------------------------------------------------------------------------\r
 252 \r
 253 Yadda yadda disclaimer yadda probably not perfect yadda well it's okay anyway\r
 254 yadda yadda.\r
 255 \r
 256 -----------------------------------------------------------------------------\r
 257 \r
 258 Basics\r
 259 ------\r
 260 \r
 261 - The reverb buffer is 22khz 16-bit mono PCM.\r
 262 - It starts at the reverb address given by 1DA2, extends to\r
 263   the end of sound RAM, and wraps back to the 1DA2 address.\r
 264 \r
 265 Setting the address at 1DA2 resets the current reverb work address.\r
 266 \r
 267 This work address ALWAYS increments every 1/22050 sec., regardless of\r
 268 whether reverb is enabled (bit 7 of 1DAA set).\r
 269 \r
 270 And the contents of the reverb buffer ALWAYS play, scaled by the\r
 271 "reverberation depth left/right" volumes (1D84/1D86).\r
 272 (which, by the way, appear to be scaled so 3FFF=approx. 1.0, 4000=-1.0)\r
 273 \r
 274 -----------------------------------------------------------------------------\r
 275 \r
 276 Register names\r
 277 --------------\r
 278 \r
 279 These are probably not their real names.\r
 280 These are probably not even correct names.\r
 281 We will use them anyway, because we can.\r
 282 \r
 283 1DC0: FB_SRC_A       (offset)\r
 284 1DC2: FB_SRC_B       (offset)\r
 285 1DC4: IIR_ALPHA      (coef.)\r
 286 1DC6: ACC_COEF_A     (coef.)\r
 287 1DC8: ACC_COEF_B     (coef.)\r
 288 1DCA: ACC_COEF_C     (coef.)\r
 289 1DCC: ACC_COEF_D     (coef.)\r
 290 1DCE: IIR_COEF       (coef.)\r
 291 1DD0: FB_ALPHA       (coef.)\r
 292 1DD2: FB_X           (coef.)\r
 293 1DD4: IIR_DEST_A0    (offset)\r
 294 1DD6: IIR_DEST_A1    (offset)\r
 295 1DD8: ACC_SRC_A0     (offset)\r
 296 1DDA: ACC_SRC_A1     (offset)\r
 297 1DDC: ACC_SRC_B0     (offset)\r
 298 1DDE: ACC_SRC_B1     (offset)\r
 299 1DE0: IIR_SRC_A0     (offset)\r
 300 1DE2: IIR_SRC_A1     (offset)\r
 301 1DE4: IIR_DEST_B0    (offset)\r
 302 1DE6: IIR_DEST_B1    (offset)\r
 303 1DE8: ACC_SRC_C0     (offset)\r
 304 1DEA: ACC_SRC_C1     (offset)\r
 305 1DEC: ACC_SRC_D0     (offset)\r
 306 1DEE: ACC_SRC_D1     (offset)\r
 307 1DF0: IIR_SRC_B1     (offset)\r
 308 1DF2: IIR_SRC_B0     (offset)\r
 309 1DF4: MIX_DEST_A0    (offset)\r
 310 1DF6: MIX_DEST_A1    (offset)\r
 311 1DF8: MIX_DEST_B0    (offset)\r
 312 1DFA: MIX_DEST_B1    (offset)\r
 313 1DFC: IN_COEF_L      (coef.)\r
 314 1DFE: IN_COEF_R      (coef.)\r
 315 \r
 316 The coefficients are signed fractional values.\r
 317 -32768 would be -1.0\r
 318  32768 would be  1.0 (if it were possible... the highest is of course 32767)\r
 319 \r
 320 The offsets are (byte/8) offsets into the reverb buffer.\r
 321 i.e. you multiply them by 8, you get byte offsets.\r
 322 You can also think of them as (samples/4) offsets.\r
 323 They appear to be signed.  They can be negative.\r
 324 None of the documented presets make them negative, though.\r
 325 \r
 326 Yes, 1DF0 and 1DF2 appear to be backwards.  Not a typo.\r
 327 \r
 328 -----------------------------------------------------------------------------\r
 329 \r
 330 What it does\r
 331 ------------\r
 332 \r
 333 We take all reverb sources:\r
 334 - regular channels that have the reverb bit on\r
 335 - cd and external sources, if their reverb bits are on\r
 336 and mix them into one stereo 44100hz signal.\r
 337 \r
 338 Lowpass/downsample that to 22050hz.  The PSX uses a proper bandlimiting\r
 339 algorithm here, but I haven't figured out the hysterically exact specifics.\r
 340 I use an 8-tap filter with these coefficients, which are nice but probably\r
 341 not the real ones:\r
 342 \r
 343 0.037828187894\r
 344 0.157538631280\r
 345 0.321159685278\r
 346 0.449322115345\r
 347 0.449322115345\r
 348 0.321159685278\r
 349 0.157538631280\r
 350 0.037828187894\r
 351 \r
 352 So we have two input samples (INPUT_SAMPLE_L, INPUT_SAMPLE_R) every 22050hz.\r
 353 \r
 354 * IN MY EMULATION, I divide these by 2 to make it clip less.\r
 355   (and of course the L/R output coefficients are adjusted to compensate)\r
 356   The real thing appears to not do this.\r
 357 \r
 358 At every 22050hz tick:\r
 359 - If the reverb bit is enabled (bit 7 of 1DAA), execute the reverb\r
 360   steady-state algorithm described below\r
 361 - AFTERWARDS, retrieve the "wet out" L and R samples from the reverb buffer\r
 362   (This part may not be exactly right and I guessed at the coefs. TODO: check later.)\r
 363   L is: 0.333 * (buffer[MIX_DEST_A0] + buffer[MIX_DEST_B0])\r
 364   R is: 0.333 * (buffer[MIX_DEST_A1] + buffer[MIX_DEST_B1])\r
 365 - Advance the current buffer position by 1 sample\r
 366 \r
 367 The wet out L and R are then upsampled to 44100hz and played at the\r
 368 "reverberation depth left/right" (1D84/1D86) volume, independent of the main\r
 369 volume.\r
 370 \r
 371 -----------------------------------------------------------------------------\r
 372 \r
 373 Reverb steady-state\r
 374 -------------------\r
 375 \r
 376 The reverb steady-state algorithm is fairly clever, and of course by\r
 377 "clever" I mean "batshit insane".\r
 378 \r
 379 buffer[x] is relative to the current buffer position, not the beginning of\r
 380 the buffer.  Note that all buffer offsets must wrap around so they're\r
 381 contained within the reverb work area.\r
 382 \r
 383 Clipping is performed at the end... maybe also sooner, but definitely at\r
 384 the end.\r
 385 \r
 386 IIR_INPUT_A0 = buffer[IIR_SRC_A0] * IIR_COEF + INPUT_SAMPLE_L * IN_COEF_L;\r
 387 IIR_INPUT_A1 = buffer[IIR_SRC_A1] * IIR_COEF + INPUT_SAMPLE_R * IN_COEF_R;\r
 388 IIR_INPUT_B0 = buffer[IIR_SRC_B0] * IIR_COEF + INPUT_SAMPLE_L * IN_COEF_L;\r
 389 IIR_INPUT_B1 = buffer[IIR_SRC_B1] * IIR_COEF + INPUT_SAMPLE_R * IN_COEF_R;\r
 390 \r
 391 IIR_A0 = IIR_INPUT_A0 * IIR_ALPHA + buffer[IIR_DEST_A0] * (1.0 - IIR_ALPHA);\r
 392 IIR_A1 = IIR_INPUT_A1 * IIR_ALPHA + buffer[IIR_DEST_A1] * (1.0 - IIR_ALPHA);\r
 393 IIR_B0 = IIR_INPUT_B0 * IIR_ALPHA + buffer[IIR_DEST_B0] * (1.0 - IIR_ALPHA);\r
 394 IIR_B1 = IIR_INPUT_B1 * IIR_ALPHA + buffer[IIR_DEST_B1] * (1.0 - IIR_ALPHA);\r
 395 \r
 396 buffer[IIR_DEST_A0 + 1sample] = IIR_A0;\r
 397 buffer[IIR_DEST_A1 + 1sample] = IIR_A1;\r
 398 buffer[IIR_DEST_B0 + 1sample] = IIR_B0;\r
 399 buffer[IIR_DEST_B1 + 1sample] = IIR_B1;\r
 400 \r
 401 ACC0 = buffer[ACC_SRC_A0] * ACC_COEF_A +\r
 402        buffer[ACC_SRC_B0] * ACC_COEF_B +\r
 403        buffer[ACC_SRC_C0] * ACC_COEF_C +\r
 404        buffer[ACC_SRC_D0] * ACC_COEF_D;\r
 405 ACC1 = buffer[ACC_SRC_A1] * ACC_COEF_A +\r
 406        buffer[ACC_SRC_B1] * ACC_COEF_B +\r
 407        buffer[ACC_SRC_C1] * ACC_COEF_C +\r
 408        buffer[ACC_SRC_D1] * ACC_COEF_D;\r
 409 \r
 410 FB_A0 = buffer[MIX_DEST_A0 - FB_SRC_A];\r
 411 FB_A1 = buffer[MIX_DEST_A1 - FB_SRC_A];\r
 412 FB_B0 = buffer[MIX_DEST_B0 - FB_SRC_B];\r
 413 FB_B1 = buffer[MIX_DEST_B1 - FB_SRC_B];\r
 414 \r
 415 buffer[MIX_DEST_A0] = ACC0 - FB_A0 * FB_ALPHA;\r
 416 buffer[MIX_DEST_A1] = ACC1 - FB_A1 * FB_ALPHA;\r
 417 buffer[MIX_DEST_B0] = (FB_ALPHA * ACC0) - FB_A0 * (FB_ALPHA^0x8000) - FB_B0 * FB_X;\r
 418 buffer[MIX_DEST_B1] = (FB_ALPHA * ACC1) - FB_A1 * (FB_ALPHA^0x8000) - FB_B1 * FB_X;\r
 419 \r
 420 -----------------------------------------------------------------------------\r
 421 */\r
 422 \r
 423 // vim:shiftwidth=1:expandtab\r