OpenAL32/alFilter.c

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 1999-2007 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., 59 Temple Place - Suite 330,
  17  *  Boston, MA  02111-1307, USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include <stdlib.h>
  24
  25 #include "AL/al.h"
  26 #include "AL/alc.h"
  27 #include "alMain.h"
  28 #include "alFilter.h"
  29 #include "alThunk.h"
  30 #include "alError.h"
  31
  32
  33 static void InitFilterParams(ALfilter *filter, ALenum type);
  34
  35
  36 AL_API ALvoid AL_APIENTRY alGenFilters(ALsizei n, ALuint *filters)
  37 {
  38     ALCcontext *Context;
  39     ALsizei    cur = 0;
  40
  41     Context = GetContextRef();
  42     if(!Context) return;
  43
  44     al_try
  45     {
  46         ALCdevice *device = Context->Device;
  47         ALenum err;
  48
  49         CHECK_VALUE(Context, n >= 0);
  50         for(cur = 0;cur < n;cur++)
  51         {
  52             ALfilter *filter = calloc(1, sizeof(ALfilter));
  53             if(!filter)
  54                 al_throwerr(Context, AL_OUT_OF_MEMORY);
  55             InitFilterParams(filter, AL_FILTER_NULL);
  56
  57             err = NewThunkEntry(&filter->id);
  58             if(err == AL_NO_ERROR)
  59                 err = InsertUIntMapEntry(&device->FilterMap, filter->id, filter);
  60             if(err != AL_NO_ERROR)
  61             {
  62                 FreeThunkEntry(filter->id);
  63                 memset(filter, 0, sizeof(ALfilter));
  64                 free(filter);
  65
  66                 al_throwerr(Context, err);
  67             }
  68
  69             filters[cur] = filter->id;
  70         }
  71     }
  72     al_catchany()
  73     {
  74         if(cur > 0)
  75             alDeleteFilters(cur, filters);
  76     }
  77     al_endtry;
  78
  79     ALCcontext_DecRef(Context);
  80 }
  81
  82 AL_API ALvoid AL_APIENTRY alDeleteFilters(ALsizei n, const ALuint *filters)
  83 {
  84     ALCcontext *Context;
  85     ALfilter *Filter;
  86     ALsizei i;
  87
  88     Context = GetContextRef();
  89     if(!Context) return;
  90
  91     al_try
  92     {
  93         ALCdevice *device = Context->Device;
  94         CHECK_VALUE(Context, n >= 0);
  95         for(i = 0;i < n;i++)
  96         {
  97             if(filters[i] && LookupFilter(device, filters[i]) == NULL)
  98                 al_throwerr(Context, AL_INVALID_NAME);
  99         }
 100
 101         for(i = 0;i < n;i++)
 102         {
 103             if((Filter=RemoveFilter(device, filters[i])) == NULL)
 104                 continue;
 105             FreeThunkEntry(Filter->id);
 106
 107             memset(Filter, 0, sizeof(*Filter));
 108             free(Filter);
 109         }
 110     }
 111     al_endtry;
 112
 113     ALCcontext_DecRef(Context);
 114 }
 115
 116 AL_API ALboolean AL_APIENTRY alIsFilter(ALuint filter)
 117 {
 118     ALCcontext *Context;
 119     ALboolean  result;
 120
 121     Context = GetContextRef();
 122     if(!Context) return AL_FALSE;
 123
 124     result = ((!filter || LookupFilter(Context->Device, filter)) ?
 125               AL_TRUE : AL_FALSE);
 126
 127     ALCcontext_DecRef(Context);
 128
 129     return result;
 130 }
 131
 132 AL_API ALvoid AL_APIENTRY alFilteri(ALuint filter, ALenum param, ALint value)
 133 {
 134     ALCcontext *Context;
 135     ALCdevice  *Device;
 136     ALfilter   *ALFilter;
 137
 138     Context = GetContextRef();
 139     if(!Context) return;
 140
 141     Device = Context->Device;
 142     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 143         alSetError(Context, AL_INVALID_NAME);
 144     else
 145     {
 146         if(param == AL_FILTER_TYPE)
 147         {
 148             if(value == AL_FILTER_NULL || value == AL_FILTER_LOWPASS)
 149                 InitFilterParams(ALFilter, value);
 150             else
 151                 alSetError(Context, AL_INVALID_VALUE);
 152         }
 153         else
 154         {
 155             /* Call the appropriate handler */
 156             ALfilter_SetParami(ALFilter, Context, param, value);
 157         }
 158     }
 159
 160     ALCcontext_DecRef(Context);
 161 }
 162
 163 AL_API ALvoid AL_APIENTRY alFilteriv(ALuint filter, ALenum param, const ALint *values)
 164 {
 165     ALCcontext *Context;
 166     ALCdevice  *Device;
 167     ALfilter   *ALFilter;
 168
 169     switch(param)
 170     {
 171         case AL_FILTER_TYPE:
 172             alFilteri(filter, param, values[0]);
 173             return;
 174     }
 175
 176     Context = GetContextRef();
 177     if(!Context) return;
 178
 179     Device = Context->Device;
 180     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 181         alSetError(Context, AL_INVALID_NAME);
 182     else
 183     {
 184         /* Call the appropriate handler */
 185         ALfilter_SetParamiv(ALFilter, Context, param, values);
 186     }
 187
 188     ALCcontext_DecRef(Context);
 189 }
 190
 191 AL_API ALvoid AL_APIENTRY alFilterf(ALuint filter, ALenum param, ALfloat value)
 192 {
 193     ALCcontext *Context;
 194     ALCdevice  *Device;
 195     ALfilter   *ALFilter;
 196
 197     Context = GetContextRef();
 198     if(!Context) return;
 199
 200     Device = Context->Device;
 201     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 202         alSetError(Context, AL_INVALID_NAME);
 203     else
 204     {
 205         /* Call the appropriate handler */
 206         ALfilter_SetParamf(ALFilter, Context, param, value);
 207     }
 208
 209     ALCcontext_DecRef(Context);
 210 }
 211
 212 AL_API ALvoid AL_APIENTRY alFilterfv(ALuint filter, ALenum param, const ALfloat *values)
 213 {
 214     ALCcontext *Context;
 215     ALCdevice  *Device;
 216     ALfilter   *ALFilter;
 217
 218     Context = GetContextRef();
 219     if(!Context) return;
 220
 221     Device = Context->Device;
 222     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 223         alSetError(Context, AL_INVALID_NAME);
 224     else
 225     {
 226         /* Call the appropriate handler */
 227         ALfilter_SetParamfv(ALFilter, Context, param, values);
 228     }
 229
 230     ALCcontext_DecRef(Context);
 231 }
 232
 233 AL_API ALvoid AL_APIENTRY alGetFilteri(ALuint filter, ALenum param, ALint *value)
 234 {
 235     ALCcontext *Context;
 236     ALCdevice  *Device;
 237     ALfilter   *ALFilter;
 238
 239     Context = GetContextRef();
 240     if(!Context) return;
 241
 242     Device = Context->Device;
 243     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 244         alSetError(Context, AL_INVALID_NAME);
 245     else
 246     {
 247         if(param == AL_FILTER_TYPE)
 248             *value = ALFilter->type;
 249         else
 250         {
 251             /* Call the appropriate handler */
 252             ALfilter_GetParami(ALFilter, Context, param, value);
 253         }
 254     }
 255
 256     ALCcontext_DecRef(Context);
 257 }
 258
 259 AL_API ALvoid AL_APIENTRY alGetFilteriv(ALuint filter, ALenum param, ALint *values)
 260 {
 261     ALCcontext *Context;
 262     ALCdevice  *Device;
 263     ALfilter   *ALFilter;
 264
 265     switch(param)
 266     {
 267         case AL_FILTER_TYPE:
 268             alGetFilteri(filter, param, values);
 269             return;
 270     }
 271
 272     Context = GetContextRef();
 273     if(!Context) return;
 274
 275     Device = Context->Device;
 276     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 277         alSetError(Context, AL_INVALID_NAME);
 278     else
 279     {
 280         /* Call the appropriate handler */
 281         ALfilter_GetParamiv(ALFilter, Context, param, values);
 282     }
 283
 284     ALCcontext_DecRef(Context);
 285 }
 286
 287 AL_API ALvoid AL_APIENTRY alGetFilterf(ALuint filter, ALenum param, ALfloat *value)
 288 {
 289     ALCcontext *Context;
 290     ALCdevice  *Device;
 291     ALfilter   *ALFilter;
 292
 293     Context = GetContextRef();
 294     if(!Context) return;
 295
 296     Device = Context->Device;
 297     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 298         alSetError(Context, AL_INVALID_NAME);
 299     else
 300     {
 301         /* Call the appropriate handler */
 302         ALfilter_GetParamf(ALFilter, Context, param, value);
 303     }
 304
 305     ALCcontext_DecRef(Context);
 306 }
 307
 308 AL_API ALvoid AL_APIENTRY alGetFilterfv(ALuint filter, ALenum param, ALfloat *values)
 309 {
 310     ALCcontext *Context;
 311     ALCdevice  *Device;
 312     ALfilter   *ALFilter;
 313
 314     Context = GetContextRef();
 315     if(!Context) return;
 316
 317     Device = Context->Device;
 318     if((ALFilter=LookupFilter(Device, filter)) == NULL)
 319         alSetError(Context, AL_INVALID_NAME);
 320     else
 321     {
 322         /* Call the appropriate handler */
 323         ALfilter_GetParamfv(ALFilter, Context, param, values);
 324     }
 325
 326     ALCcontext_DecRef(Context);
 327 }
 328
 329
 330 ALfloat lpCoeffCalc(ALfloat g, ALfloat cw)
 331 {
 332     ALfloat a = 0.0f;
 333
 334     if(g < 0.9999f) /* 1-epsilon */
 335     {
 336         /* Be careful with gains < 0.001, as that causes the coefficient head
 337          * towards 1, which will flatten the signal */
 338         g = maxf(g, 0.001f);
 339         a = (1 - g*cw - aluSqrt(2*g*(1-cw) - g*g*(1 - cw*cw))) /
 340             (1 - g);
 341     }
 342
 343     return a;
 344 }
 345
 346
 347 static void lp_SetParami(ALfilter *filter, ALCcontext *context, ALenum param, ALint val)
 348 { (void)filter;(void)param;(void)val; alSetError(context, AL_INVALID_ENUM); }
 349 static void lp_SetParamiv(ALfilter *filter, ALCcontext *context, ALenum param, const ALint *vals)
 350 { (void)filter;(void)param;(void)vals; alSetError(context, AL_INVALID_ENUM); }
 351 static void lp_SetParamf(ALfilter *filter, ALCcontext *context, ALenum param, ALfloat val)
 352 {
 353     switch(param)
 354     {
 355         case AL_LOWPASS_GAIN:
 356             if(val >= AL_LOWPASS_MIN_GAIN && val <= AL_LOWPASS_MAX_GAIN)
 357                 filter->Gain = val;
 358             else
 359                 alSetError(context, AL_INVALID_VALUE);
 360             break;
 361
 362         case AL_LOWPASS_GAINHF:
 363             if(val >= AL_LOWPASS_MIN_GAINHF && val <= AL_LOWPASS_MAX_GAINHF)
 364                 filter->GainHF = val;
 365             else
 366                 alSetError(context, AL_INVALID_VALUE);
 367             break;
 368
 369         default:
 370             alSetError(context, AL_INVALID_ENUM);
 371             break;
 372     }
 373 }
 374 static void lp_SetParamfv(ALfilter *filter, ALCcontext *context, ALenum param, const ALfloat *vals)
 375 {
 376     lp_SetParamf(filter, context, param, vals[0]);
 377 }
 378
 379 static void lp_GetParami(ALfilter *filter, ALCcontext *context, ALenum param, ALint *val)
 380 { (void)filter;(void)param;(void)val; alSetError(context, AL_INVALID_ENUM); }
 381 static void lp_GetParamiv(ALfilter *filter, ALCcontext *context, ALenum param, ALint *vals)
 382 { (void)filter;(void)param;(void)vals; alSetError(context, AL_INVALID_ENUM); }
 383 static void lp_GetParamf(ALfilter *filter, ALCcontext *context, ALenum param, ALfloat *val)
 384 {
 385     switch(param)
 386     {
 387         case AL_LOWPASS_GAIN:
 388             *val = filter->Gain;
 389             break;
 390
 391         case AL_LOWPASS_GAINHF:
 392             *val = filter->GainHF;
 393             break;
 394
 395         default:
 396             alSetError(context, AL_INVALID_ENUM);
 397             break;
 398     }
 399 }
 400 static void lp_GetParamfv(ALfilter *filter, ALCcontext *context, ALenum param, ALfloat *vals)
 401 {
 402     lp_GetParamf(filter, context, param, vals);
 403 }
 404
 405
 406 static void null_SetParami(ALfilter *filter, ALCcontext *context, ALenum param, ALint val)
 407 { (void)filter;(void)param;(void)val; alSetError(context, AL_INVALID_ENUM); }
 408 static void null_SetParamiv(ALfilter *filter, ALCcontext *context, ALenum param, const ALint *vals)
 409 { (void)filter;(void)param;(void)vals; alSetError(context, AL_INVALID_ENUM); }
 410 static void null_SetParamf(ALfilter *filter, ALCcontext *context, ALenum param, ALfloat val)
 411 { (void)filter;(void)param;(void)val; alSetError(context, AL_INVALID_ENUM); }
 412 static void null_SetParamfv(ALfilter *filter, ALCcontext *context, ALenum param, const ALfloat *vals)
 413 { (void)filter;(void)param;(void)vals; alSetError(context, AL_INVALID_ENUM); }
 414
 415 static void null_GetParami(ALfilter *filter, ALCcontext *context, ALenum param, ALint *val)
 416 { (void)filter;(void)param;(void)val; alSetError(context, AL_INVALID_ENUM); }
 417 static void null_GetParamiv(ALfilter *filter, ALCcontext *context, ALenum param, ALint *vals)
 418 { (void)filter;(void)param;(void)vals; alSetError(context, AL_INVALID_ENUM); }
 419 static void null_GetParamf(ALfilter *filter, ALCcontext *context, ALenum param, ALfloat *val)
 420 { (void)filter;(void)param;(void)val; alSetError(context, AL_INVALID_ENUM); }
 421 static void null_GetParamfv(ALfilter *filter, ALCcontext *context, ALenum param, ALfloat *vals)
 422 { (void)filter;(void)param;(void)vals; alSetError(context, AL_INVALID_ENUM); }
 423
 424
 425 ALvoid ReleaseALFilters(ALCdevice *device)
 426 {
 427     ALsizei i;
 428     for(i = 0;i < device->FilterMap.size;i++)
 429     {
 430         ALfilter *temp = device->FilterMap.array[i].value;
 431         device->FilterMap.array[i].value = NULL;
 432
 433         // Release filter structure
 434         FreeThunkEntry(temp->id);
 435         memset(temp, 0, sizeof(ALfilter));
 436         free(temp);
 437     }
 438 }
 439
 440
 441 static void InitFilterParams(ALfilter *filter, ALenum type)
 442 {
 443     if(type == AL_FILTER_LOWPASS)
 444     {
 445         filter->Gain = AL_LOWPASS_DEFAULT_GAIN;
 446         filter->GainHF = AL_LOWPASS_DEFAULT_GAINHF;
 447
 448         filter->SetParami  = lp_SetParami;
 449         filter->SetParamiv = lp_SetParamiv;
 450         filter->SetParamf  = lp_SetParamf;
 451         filter->SetParamfv = lp_SetParamfv;
 452         filter->GetParami  = lp_GetParami;
 453         filter->GetParamiv = lp_GetParamiv;
 454         filter->GetParamf  = lp_GetParamf;
 455         filter->GetParamfv = lp_GetParamfv;
 456     }
 457     else
 458     {
 459         filter->SetParami  = null_SetParami;
 460         filter->SetParamiv = null_SetParamiv;
 461         filter->SetParamf  = null_SetParamf;
 462         filter->SetParamfv = null_SetParamfv;
 463         filter->GetParami  = null_GetParami;
 464         filter->GetParamiv = null_GetParamiv;
 465         filter->GetParamf  = null_GetParamf;
 466         filter->GetParamfv = null_GetParamfv;
 467     }
 468     filter->type = type;
 469 }