Alc/panning.c

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 1999-2010 by authors.
   4  * This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  *  License along with this library; if not, write to the
  16  *  Free Software Foundation, Inc.,
  17  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include <math.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <ctype.h>
  27 #include <assert.h>
  28
  29 #include "alMain.h"
  30 #include "AL/al.h"
  31 #include "AL/alc.h"
  32 #include "alu.h"
  33 #include "bool.h"
  34
  35
  36 void ComputeAngleGains(const ALCdevice *device, ALfloat angle, ALfloat elevation, ALfloat ingain, ALfloat gains[MAX_OUTPUT_CHANNELS])
  37 {
  38     ALfloat dir[3] = {
  39         sinf(angle) * cosf(elevation),
  40         sinf(elevation),
  41         -cosf(angle) * cosf(elevation)
  42     };
  43     ComputeDirectionalGains(device, dir, ingain, gains);
  44 }
  45
  46 void ComputeDirectionalGains(const ALCdevice *device, const ALfloat dir[3], ALfloat ingain, ALfloat gains[MAX_OUTPUT_CHANNELS])
  47 {
  48     ALfloat coeffs[MAX_AMBI_COEFFS];
  49     ALuint i, j;
  50     /* Convert from OpenAL coords to Ambisonics. */
  51     ALfloat x = -dir[2];
  52     ALfloat y = -dir[0];
  53     ALfloat z =  dir[1];
  54
  55     coeffs[0] = 0.7071f; /* sqrt(1.0 / 2.0) */
  56     coeffs[1] = x; /* X */
  57     coeffs[2] = y; /* Y */
  58     coeffs[3] = z; /* Z */
  59     coeffs[4] = 0.5f * (3.0f*z*z - 1.0f); /* 0.5 * (3*Z*Z - 1) */
  60     coeffs[5] = 2.0f * z * x; /* 2*Z*X */
  61     coeffs[6] = 2.0f * y * z; /* 2*Y*Z */
  62     coeffs[7] = x*x - y*y; /* X*X - Y*Y */
  63     coeffs[8] = 2.0f * x * y; /* 2*X*Y */
  64     coeffs[9] = 0.5f * z * (5.0f*z*z - 3.0f); /* 0.5 * Z * (5*Z*Z - 3) */
  65     coeffs[10] = 0.7262f * x * (5.0f*z*z - 1.0f); /* sqrt(135.0 / 256.0) * X * (5*Z*Z - 1) */
  66     coeffs[11] = 0.7262f * y * (5.0f*z*z - 1.0f); /* sqrt(135.0 / 256.0) * Y * (5*Z*Z - 1) */
  67     coeffs[12] = 2.5981f * z * (x*x - y*y); /* sqrt(27.0 / 4.0) * Z * (X*X - Y*Y) */
  68     coeffs[13] = 5.1962f * x * y * z; /* sqrt(27) * X * Y * Z */
  69     coeffs[14] = x * (x*x - 3.0f*y*y); /* X * (X*X - 3*Y*Y) */
  70     coeffs[15] = y * (3.0f*x*x - y*y); /* Y * (3*X*X - Y*Y) */
  71
  72     for(i = 0;i < MAX_OUTPUT_CHANNELS;i++)
  73         gains[i] = 0.0f;
  74     for(i = 0;i < device->NumChannels;i++)
  75     {
  76         for(j = 0;j < MAX_AMBI_COEFFS;j++)
  77             gains[i] += device->Channel[i].HOACoeff[j]*coeffs[j];
  78         gains[i] = maxf(gains[i], 0.0f) * ingain;
  79     }
  80 }
  81
  82 void ComputeAmbientGains(const ALCdevice *device, ALfloat ingain, ALfloat gains[MAX_OUTPUT_CHANNELS])
  83 {
  84     ALuint i;
  85
  86     for(i = 0;i < MAX_OUTPUT_CHANNELS;i++)
  87         gains[i] = 0.0f;
  88     for(i = 0;i < device->NumChannels;i++)
  89     {
  90         // The W coefficients are based on a mathematical average of the
  91         // output, scaled by sqrt(2) to compensate for FuMa-style Ambisonics
  92         // scaling the W channel input by sqrt(0.5). The square root of the
  93         // base average provides for a more perceptual average volume, better
  94         // suited to non-directional gains.
  95         gains[i] = sqrtf(device->Channel[i].HOACoeff[0]/1.4142f)*1.4142f * ingain;
  96     }
  97 }
  98
  99 void ComputeBFormatGains(const ALCdevice *device, const ALfloat mtx[4], ALfloat ingain, ALfloat gains[MAX_OUTPUT_CHANNELS])
 100 {
 101     ALuint i, j;
 102
 103     for(i = 0;i < MAX_OUTPUT_CHANNELS;i++)
 104         gains[i] = 0.0f;
 105     for(i = 0;i < device->NumChannels;i++)
 106     {
 107         for(j = 0;j < 4;j++)
 108             gains[i] += device->Channel[i].FOACoeff[j] * mtx[j];
 109         gains[i] *= ingain;
 110     }
 111 }
 112
 113
 114 static inline const char *GetLabelFromChannel(enum Channel channel)
 115 {
 116     switch(channel)
 117     {
 118         case FrontLeft: return "front-left";
 119         case FrontRight: return "front-right";
 120         case FrontCenter: return "front-center";
 121         case LFE: return "lfe";
 122         case BackLeft: return "back-left";
 123         case BackRight: return "back-right";
 124         case BackCenter: return "back-center";
 125         case SideLeft: return "side-left";
 126         case SideRight: return "side-right";
 127         case InvalidChannel: break;
 128     }
 129     return "(unknown)";
 130 }
 131
 132
 133 typedef struct ChannelMap {
 134     enum Channel ChanName;
 135     ChannelConfig Config;
 136 } ChannelMap;
 137
 138 static void SetChannelMap(ALCdevice *device, const ChannelMap *chanmap, size_t count)
 139 {
 140     size_t i, j;
 141
 142     for(i = 0;i < MAX_OUTPUT_CHANNELS && device->ChannelName[i] != InvalidChannel;i++)
 143     {
 144         if(device->ChannelName[i] == LFE)
 145         {
 146             for(j = 0;j < MAX_AMBI_COEFFS;j++)
 147                 device->Channel[i].HOACoeff[j] = 0.0f;
 148             for(j = 0;j < 4;j++)
 149                 device->Channel[i].FOACoeff[j] = 0.0f;
 150             continue;
 151         }
 152
 153         for(j = 0;j < count;j++)
 154         {
 155             if(device->ChannelName[i] == chanmap[j].ChanName)
 156             {
 157                 device->Channel[i] = chanmap[j].Config;
 158                 break;
 159             }
 160         }
 161         if(j == count)
 162             ERR("Failed to match %s channel ("SZFMT") in config\n", GetLabelFromChannel(device->ChannelName[i]), i);
 163     }
 164     device->NumChannels = i;
 165 }
 166
 167 static bool LoadChannelSetup(ALCdevice *device)
 168 {
 169     static const enum Channel mono_chans[1] = {
 170         FrontCenter
 171     }, stereo_chans[2] = {
 172         FrontLeft, FrontRight
 173     }, quad_chans[4] = {
 174         FrontLeft, FrontRight,
 175         BackLeft, BackRight
 176     }, surround51_chans[5] = {
 177         FrontLeft, FrontRight, FrontCenter,
 178         SideLeft, SideRight
 179     }, surround51rear_chans[5] = {
 180         FrontLeft, FrontRight, FrontCenter,
 181         BackLeft, BackRight
 182     }, surround61_chans[6] = {
 183         FrontLeft, FrontRight,
 184         FrontCenter, BackCenter,
 185         SideLeft, SideRight
 186     }, surround71_chans[7] = {
 187         FrontLeft, FrontRight, FrontCenter,
 188         BackLeft, BackRight,
 189         SideLeft, SideRight
 190     };
 191     ChannelMap chanmap[MAX_OUTPUT_CHANNELS];
 192     const enum Channel *channels = NULL;
 193     const char *layout = NULL;
 194     size_t count = 0;
 195     size_t i;
 196
 197     switch(device->FmtChans)
 198     {
 199         case DevFmtMono:
 200             layout = "mono";
 201             channels = mono_chans;
 202             count = COUNTOF(mono_chans);
 203             break;
 204         case DevFmtStereo:
 205             layout = "stereo";
 206             channels = stereo_chans;
 207             count = COUNTOF(stereo_chans);
 208             break;
 209         case DevFmtQuad:
 210             layout = "quad";
 211             channels = quad_chans;
 212             count = COUNTOF(quad_chans);
 213             break;
 214         case DevFmtX51:
 215             layout = "surround51";
 216             channels = surround51_chans;
 217             count = COUNTOF(surround51_chans);
 218             break;
 219         case DevFmtX51Rear:
 220             layout = "surround51rear";
 221             channels = surround51rear_chans;
 222             count = COUNTOF(surround51rear_chans);
 223             break;
 224         case DevFmtX61:
 225             layout = "surround61";
 226             channels = surround61_chans;
 227             count = COUNTOF(surround61_chans);
 228             break;
 229         case DevFmtX71:
 230             layout = "surround71";
 231             channels = surround71_chans;
 232             count = COUNTOF(surround71_chans);
 233             break;
 234     }
 235
 236     if(!layout)
 237         return false;
 238     else
 239     {
 240         char name[32];
 241         snprintf(name, sizeof(name), "%s/enable", layout);
 242         if(!GetConfigValueBool("layouts", name, 0))
 243             return false;
 244     }
 245
 246     for(i = 0;i < count;i++)
 247     {
 248         const char *channame;
 249         char chanlayout[32];
 250         const char *value;
 251         int props;
 252
 253         chanmap[i].ChanName = channels[i];
 254         channame = GetLabelFromChannel(channels[i]);
 255
 256         snprintf(chanlayout, sizeof(chanlayout), "%s/%s", layout, channame);
 257         if(!ConfigValueStr("layouts", chanlayout, &value))
 258         {
 259             ERR("Missing channel %s\n", channame);
 260             return false;
 261         }
 262         props = sscanf(value, " %f %f %f %f %f %f %f %f %f %f %f %f %f %f %f %f ; %f %f %f %f",
 263             &chanmap[i].Config.HOACoeff[0], &chanmap[i].Config.HOACoeff[1], &chanmap[i].Config.HOACoeff[2],
 264             &chanmap[i].Config.HOACoeff[3], &chanmap[i].Config.HOACoeff[4], &chanmap[i].Config.HOACoeff[5],
 265             &chanmap[i].Config.HOACoeff[6], &chanmap[i].Config.HOACoeff[7], &chanmap[i].Config.HOACoeff[8],
 266             &chanmap[i].Config.HOACoeff[9], &chanmap[i].Config.HOACoeff[10], &chanmap[i].Config.HOACoeff[11],
 267             &chanmap[i].Config.HOACoeff[12], &chanmap[i].Config.HOACoeff[13], &chanmap[i].Config.HOACoeff[14],
 268             &chanmap[i].Config.HOACoeff[15], &chanmap[i].Config.FOACoeff[0], &chanmap[i].Config.FOACoeff[1],
 269             &chanmap[i].Config.FOACoeff[2], &chanmap[i].Config.FOACoeff[3]);
 270         if(props == 0)
 271         {
 272             ERR("Failed to parse %s channel's properties\n", channame);
 273             return false;
 274         }
 275
 276         if(props < 20)
 277         {
 278             ERR("Failed to parse %s channel's elements (expected 20, got %d)\n", channame, props);
 279             return false;
 280         }
 281     }
 282     SetChannelMap(device, chanmap, count);
 283     return true;
 284 }
 285
 286 ALvoid aluInitPanning(ALCdevice *device)
 287 {
 288     static const ChannelMap MonoCfg[1] = {
 289         { FrontCenter, { { 1.4142f }, { 1.4142f } } },
 290     }, StereoCfg[2] = {
 291         { FrontLeft,   { { 0.7071f, 0.0f,  0.5f, 0.0f }, { 0.7071f, 0.0f,  0.5f, 0.0f } } },
 292         { FrontRight,  { { 0.7071f, 0.0f, -0.5f, 0.0f }, { 0.7071f, 0.0f, -0.5f, 0.0f } } },
 293     }, QuadCfg[4] = {
 294         { FrontLeft,   { { 0.353558f,  0.306181f,  0.306192f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f,  0.117183f }, { 0.353553f,  0.250000f,  0.250000f, 0.0f  } } },
 295         { FrontRight,  { { 0.353543f,  0.306181f, -0.306192f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f, -0.117193f }, { 0.353553f,  0.250000f, -0.250000f, 0.0f  } } },
 296         { BackLeft,    { { 0.353543f, -0.306192f,  0.306181f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f, -0.117193f }, { 0.353553f, -0.250000f,  0.250000f, 0.0f  } } },
 297         { BackRight,   { { 0.353558f, -0.306192f, -0.306181f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f,  0.117183f }, { 0.353553f, -0.250000f, -0.250000f, 0.0f  } } },
 298     }, X51SideCfg[5] = {
 299         { FrontLeft,   { { 0.208954f,  0.212846f,  0.238350f, 0.0f, 0.0f, 0.0f, 0.0f, -0.017738f,  0.204014f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.051023f,  0.047490f }, { 0.208954f,  0.162905f,  0.182425f, 0.0f } } },
 300         { FrontRight,  { { 0.208954f,  0.212846f, -0.238350f, 0.0f, 0.0f, 0.0f, 0.0f, -0.017738f, -0.204014f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.051023f, -0.047490f }, { 0.208954f,  0.162905f, -0.182425f, 0.0f } } },
 301         { FrontCenter, { { 0.109403f,  0.179490f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f,  0.142031f, -0.000002f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.072024f, -0.000001f }, { 0.109403f,  0.137375f,  0.000000f, 0.0f } } },
 302         { SideLeft,    { { 0.470936f, -0.369626f,  0.349386f, 0.0f, 0.0f, 0.0f, 0.0f, -0.031375f, -0.058144f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.007119f, -0.043968f }, { 0.470934f, -0.282903f,  0.267406f, 0.0f } } },
 303         { SideRight,   { { 0.470936f, -0.369626f, -0.349386f, 0.0f, 0.0f, 0.0f, 0.0f, -0.031375f,  0.058144f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.007119f,  0.043968f }, { 0.470934f, -0.282903f, -0.267406f, 0.0f } } },
 304     }, X51RearCfg[5] = {
 305         { FrontLeft,   { { 0.208954f,  0.212846f,  0.238350f, 0.0f, 0.0f, 0.0f, 0.0f, -0.017738f,  0.204014f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.051023f,  0.047490f }, { 0.208954f,  0.162905f,  0.182425f, 0.0f } } },
 306         { FrontRight,  { { 0.208954f,  0.212846f, -0.238350f, 0.0f, 0.0f, 0.0f, 0.0f, -0.017738f, -0.204014f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.051023f, -0.047490f }, { 0.208954f,  0.162905f, -0.182425f, 0.0f } } },
 307         { FrontCenter, { { 0.109403f,  0.179490f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f,  0.142031f, -0.000002f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.072024f, -0.000001f }, { 0.109403f,  0.137375f,  0.000000f, 0.0f } } },
 308         { BackLeft,    { { 0.470936f, -0.369626f,  0.349386f, 0.0f, 0.0f, 0.0f, 0.0f, -0.031375f, -0.058144f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.007119f, -0.043968f }, { 0.470934f, -0.282903f,  0.267406f, 0.0f } } },
 309         { BackRight,   { { 0.470936f, -0.369626f, -0.349386f, 0.0f, 0.0f, 0.0f, 0.0f, -0.031375f,  0.058144f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.007119f,  0.043968f }, { 0.470934f, -0.282903f, -0.267406f, 0.0f } } },
 310     }, X61Cfg[6] = {
 311         { FrontLeft,   { { 0.167065f,  0.200583f,  0.172695f, 0.0f, 0.0f, 0.0f, 0.0f,  0.029855f,  0.186407f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.039241f,  0.068910f }, { 0.167065f,  0.153519f,  0.132175f, 0.0f } } },
 312         { FrontRight,  { { 0.167065f,  0.200583f, -0.172695f, 0.0f, 0.0f, 0.0f, 0.0f,  0.029855f, -0.186407f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.039241f, -0.068910f }, { 0.167065f,  0.153519f, -0.132175f, 0.0f } } },
 313         { FrontCenter, { { 0.109403f,  0.179490f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f,  0.142031f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.072024f, -0.000001f }, { 0.109403f,  0.137375f,  0.000000f, 0.0f } } },
 314         { BackCenter,  { { 0.353556f, -0.461940f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f,  0.165723f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f,  0.000005f }, { 0.353556f, -0.353554f,  0.000000f, 0.0f } } },
 315         { SideLeft,    { { 0.289151f, -0.081301f,  0.401292f, 0.0f, 0.0f, 0.0f, 0.0f, -0.188208f, -0.071420f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.010099f, -0.032897f }, { 0.289151f, -0.062225f,  0.307136f, 0.0f } } },
 316         { SideRight,   { { 0.289151f, -0.081301f, -0.401292f, 0.0f, 0.0f, 0.0f, 0.0f, -0.188208f,  0.071420f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.010099f,  0.032897f }, { 0.289151f, -0.062225f, -0.307136f, 0.0f } } },
 317     }, X71Cfg[7] = {
 318         { FrontLeft,   { { 0.167065f,  0.200583f,  0.172695f, 0.0f, 0.0f, 0.0f, 0.0f,  0.029855f,  0.186407f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.039241f,  0.068910f }, { 0.167065f,  0.153519f,  0.132175f, 0.0f } } },
 319         { FrontRight,  { { 0.167065f,  0.200583f, -0.172695f, 0.0f, 0.0f, 0.0f, 0.0f,  0.029855f, -0.186407f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, -0.039241f, -0.068910f }, { 0.167065f,  0.153519f, -0.132175f, 0.0f } } },
 320         { FrontCenter, { { 0.109403f,  0.179490f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f,  0.142031f,  0.000000f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.072024f,  0.000000f }, { 0.109403f,  0.137375f,  0.000000f, 0.0f } } },
 321         { BackLeft,    { { 0.224752f, -0.295009f,  0.170325f, 0.0f, 0.0f, 0.0f, 0.0f,  0.105349f, -0.182473f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f,  0.065799f }, { 0.224752f, -0.225790f,  0.130361f, 0.0f } } },
 322         { BackRight,   { { 0.224752f, -0.295009f, -0.170325f, 0.0f, 0.0f, 0.0f, 0.0f,  0.105349f,  0.182473f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f, -0.065799f }, { 0.224752f, -0.225790f, -0.130361f, 0.0f } } },
 323         { SideLeft,    { { 0.224739f,  0.000002f,  0.340644f, 0.0f, 0.0f, 0.0f, 0.0f, -0.210697f,  0.000002f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f, -0.065795f }, { 0.224739f,  0.000000f,  0.260717f, 0.0f } } },
 324         { SideRight,   { { 0.224739f,  0.000002f, -0.340644f, 0.0f, 0.0f, 0.0f, 0.0f, -0.210697f, -0.000002f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f,  0.000000f,  0.065795f }, { 0.224739f,  0.000000f, -0.260717f, 0.0f } } },
 325     };
 326     const ChannelMap *chanmap = NULL;
 327     size_t count = 0;
 328
 329     memset(device->Channel, 0, sizeof(device->Channel));
 330     device->NumChannels = 0;
 331
 332     if(LoadChannelSetup(device))
 333         return;
 334
 335     switch(device->FmtChans)
 336     {
 337         case DevFmtMono:
 338             count = COUNTOF(MonoCfg);
 339             chanmap = MonoCfg;
 340             break;
 341
 342         case DevFmtStereo:
 343             count = COUNTOF(StereoCfg);
 344             chanmap = StereoCfg;
 345             break;
 346
 347         case DevFmtQuad:
 348             count = COUNTOF(QuadCfg);
 349             chanmap = QuadCfg;
 350             break;
 351
 352         case DevFmtX51:
 353             count = COUNTOF(X51SideCfg);
 354             chanmap = X51SideCfg;
 355             break;
 356
 357         case DevFmtX51Rear:
 358             count = COUNTOF(X51RearCfg);
 359             chanmap = X51RearCfg;
 360             break;
 361
 362         case DevFmtX61:
 363             count = COUNTOF(X61Cfg);
 364             chanmap = X61Cfg;
 365             break;
 366
 367         case DevFmtX71:
 368             count = COUNTOF(X71Cfg);
 369             chanmap = X71Cfg;
 370             break;
 371     }
 372
 373     SetChannelMap(device, chanmap, count);
 374 }