OpenAL32/alAuxEffectSlot.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 #include <math.h>
  25
  26 #include "AL/al.h"
  27 #include "AL/alc.h"
  28 #include "alMain.h"
  29 #include "alAuxEffectSlot.h"
  30 #include "alThunk.h"
  31 #include "alError.h"
  32 #include "alSource.h"
  33
  34
  35 static ALenum AddEffectSlotArray(ALCcontext *Context, ALsizei count, const ALuint *slots);
  36 static ALvoid RemoveEffectSlotArray(ALCcontext *Context, ALeffectslot *slot);
  37
  38
  39 AL_API ALvoid AL_APIENTRY alGenAuxiliaryEffectSlots(ALsizei n, ALuint *effectslots)
  40 {
  41     ALCcontext *Context;
  42     ALsizei    cur = 0;
  43
  44     Context = GetContextRef();
  45     if(!Context) return;
  46
  47     al_try
  48     {
  49         ALenum err;
  50
  51         CHECK_VALUE(Context, n >= 0);
  52         for(cur = 0;cur < n;cur++)
  53         {
  54             ALeffectslot *slot = calloc(1, sizeof(ALeffectslot));
  55             err = AL_OUT_OF_MEMORY;
  56             if(!slot || (err=InitEffectSlot(slot)) != AL_NO_ERROR)
  57             {
  58                 free(slot);
  59                 al_throwerr(Context, err);
  60                 break;
  61             }
  62
  63             err = NewThunkEntry(&slot->id);
  64             if(err == AL_NO_ERROR)
  65                 err = InsertUIntMapEntry(&Context->EffectSlotMap, slot->id, slot);
  66             if(err != AL_NO_ERROR)
  67             {
  68                 FreeThunkEntry(slot->id);
  69                 ALeffectState_Destroy(slot->EffectState);
  70                 free(slot);
  71
  72                 al_throwerr(Context, err);
  73             }
  74
  75             effectslots[cur] = slot->id;
  76         }
  77         err = AddEffectSlotArray(Context, n, effectslots);
  78         if(err != AL_NO_ERROR)
  79             al_throwerr(Context, err);
  80     }
  81     al_catchany()
  82     {
  83         if(cur > 0)
  84             alDeleteAuxiliaryEffectSlots(cur, effectslots);
  85     }
  86     al_endtry;
  87
  88     ALCcontext_DecRef(Context);
  89 }
  90
  91 AL_API ALvoid AL_APIENTRY alDeleteAuxiliaryEffectSlots(ALsizei n, const ALuint *effectslots)
  92 {
  93     ALCcontext *Context;
  94     ALeffectslot *slot;
  95     ALsizei i;
  96
  97     Context = GetContextRef();
  98     if(!Context) return;
  99
 100     al_try
 101     {
 102         CHECK_VALUE(Context, n >= 0);
 103         for(i = 0;i < n;i++)
 104         {
 105             if((slot=LookupEffectSlot(Context, effectslots[i])) == NULL)
 106                 al_throwerr(Context, AL_INVALID_NAME);
 107             if(slot->ref != 0)
 108                 al_throwerr(Context, AL_INVALID_OPERATION);
 109         }
 110
 111         // All effectslots are valid
 112         for(i = 0;i < n;i++)
 113         {
 114             if((slot=RemoveEffectSlot(Context, effectslots[i])) == NULL)
 115                 continue;
 116             FreeThunkEntry(slot->id);
 117
 118             RemoveEffectSlotArray(Context, slot);
 119             ALeffectState_Destroy(slot->EffectState);
 120
 121             memset(slot, 0, sizeof(*slot));
 122             free(slot);
 123         }
 124     }
 125     al_endtry;
 126
 127     ALCcontext_DecRef(Context);
 128 }
 129
 130 AL_API ALboolean AL_APIENTRY alIsAuxiliaryEffectSlot(ALuint effectslot)
 131 {
 132     ALCcontext *Context;
 133     ALboolean  result;
 134
 135     Context = GetContextRef();
 136     if(!Context) return AL_FALSE;
 137
 138     result = (LookupEffectSlot(Context, effectslot) ? AL_TRUE : AL_FALSE);
 139
 140     ALCcontext_DecRef(Context);
 141
 142     return result;
 143 }
 144
 145 AL_API ALvoid AL_APIENTRY alAuxiliaryEffectSloti(ALuint effectslot, ALenum param, ALint value)
 146 {
 147     ALCcontext *Context;
 148     ALeffectslot *Slot;
 149     ALeffect *effect = NULL;
 150     ALenum err;
 151
 152     Context = GetContextRef();
 153     if(!Context) return;
 154
 155     al_try
 156     {
 157         ALCdevice *device = Context->Device;
 158         if((Slot=LookupEffectSlot(Context, effectslot)) == NULL)
 159             al_throwerr(Context, AL_INVALID_NAME);
 160         switch(param)
 161         {
 162         case AL_EFFECTSLOT_EFFECT:
 163             CHECK_VALUE(Context, value == 0 || (effect=LookupEffect(device, value)) != NULL);
 164
 165             err = InitializeEffect(device, Slot, effect);
 166             if(err != AL_NO_ERROR)
 167                 al_throwerr(Context, err);
 168             Context->UpdateSources = AL_TRUE;
 169             break;
 170
 171         case AL_EFFECTSLOT_AUXILIARY_SEND_AUTO:
 172             CHECK_VALUE(Context, value == AL_TRUE || value == AL_FALSE);
 173
 174             Slot->AuxSendAuto = value;
 175             Context->UpdateSources = AL_TRUE;
 176             break;
 177
 178         default:
 179             al_throwerr(Context, AL_INVALID_ENUM);
 180         }
 181     }
 182     al_endtry;
 183
 184     ALCcontext_DecRef(Context);
 185 }
 186
 187 AL_API ALvoid AL_APIENTRY alAuxiliaryEffectSlotiv(ALuint effectslot, ALenum param, const ALint *values)
 188 {
 189     ALCcontext *Context;
 190
 191     switch(param)
 192     {
 193         case AL_EFFECTSLOT_EFFECT:
 194         case AL_EFFECTSLOT_AUXILIARY_SEND_AUTO:
 195             alAuxiliaryEffectSloti(effectslot, param, values[0]);
 196             return;
 197     }
 198
 199     Context = GetContextRef();
 200     if(!Context) return;
 201
 202     al_try
 203     {
 204         if(LookupEffectSlot(Context, effectslot) == NULL)
 205             al_throwerr(Context, AL_INVALID_NAME);
 206         switch(param)
 207         {
 208         default:
 209             al_throwerr(Context, AL_INVALID_ENUM);
 210         }
 211     }
 212     al_endtry;
 213
 214     ALCcontext_DecRef(Context);
 215 }
 216
 217 AL_API ALvoid AL_APIENTRY alAuxiliaryEffectSlotf(ALuint effectslot, ALenum param, ALfloat value)
 218 {
 219     ALCcontext *Context;
 220     ALeffectslot *Slot;
 221
 222     Context = GetContextRef();
 223     if(!Context) return;
 224
 225     al_try
 226     {
 227         if((Slot=LookupEffectSlot(Context, effectslot)) == NULL)
 228             al_throwerr(Context, AL_INVALID_NAME);
 229         switch(param)
 230         {
 231         case AL_EFFECTSLOT_GAIN:
 232             CHECK_VALUE(Context, value >= 0.0f && value <= 1.0f);
 233
 234             Slot->Gain = value;
 235             Slot->NeedsUpdate = AL_TRUE;
 236             break;
 237
 238         default:
 239             al_throwerr(Context, AL_INVALID_ENUM);
 240         }
 241     }
 242     al_endtry;
 243
 244     ALCcontext_DecRef(Context);
 245 }
 246
 247 AL_API ALvoid AL_APIENTRY alAuxiliaryEffectSlotfv(ALuint effectslot, ALenum param, const ALfloat *values)
 248 {
 249     ALCcontext *Context;
 250
 251     switch(param)
 252     {
 253         case AL_EFFECTSLOT_GAIN:
 254             alAuxiliaryEffectSlotf(effectslot, param, values[0]);
 255             return;
 256     }
 257
 258     Context = GetContextRef();
 259     if(!Context) return;
 260
 261     al_try
 262     {
 263         if(LookupEffectSlot(Context, effectslot) == NULL)
 264             al_throwerr(Context, AL_INVALID_NAME);
 265         switch(param)
 266         {
 267         default:
 268             al_throwerr(Context, AL_INVALID_ENUM);
 269         }
 270     }
 271     al_endtry;
 272
 273     ALCcontext_DecRef(Context);
 274 }
 275
 276 AL_API ALvoid AL_APIENTRY alGetAuxiliaryEffectSloti(ALuint effectslot, ALenum param, ALint *value)
 277 {
 278     ALCcontext *Context;
 279     ALeffectslot *Slot;
 280
 281     Context = GetContextRef();
 282     if(!Context) return;
 283
 284     al_try
 285     {
 286         if((Slot=LookupEffectSlot(Context, effectslot)) == NULL)
 287             al_throwerr(Context, AL_INVALID_NAME);
 288         switch(param)
 289         {
 290         case AL_EFFECTSLOT_EFFECT:
 291             *value = Slot->effect.id;
 292             break;
 293
 294         case AL_EFFECTSLOT_AUXILIARY_SEND_AUTO:
 295             *value = Slot->AuxSendAuto;
 296             break;
 297
 298         default:
 299             al_throwerr(Context, AL_INVALID_ENUM);
 300         }
 301     }
 302     al_endtry;
 303
 304     ALCcontext_DecRef(Context);
 305 }
 306
 307 AL_API ALvoid AL_APIENTRY alGetAuxiliaryEffectSlotiv(ALuint effectslot, ALenum param, ALint *values)
 308 {
 309     ALCcontext *Context;
 310
 311     switch(param)
 312     {
 313         case AL_EFFECTSLOT_EFFECT:
 314         case AL_EFFECTSLOT_AUXILIARY_SEND_AUTO:
 315             alGetAuxiliaryEffectSloti(effectslot, param, values);
 316             return;
 317     }
 318
 319     Context = GetContextRef();
 320     if(!Context) return;
 321
 322     al_try
 323     {
 324         if(LookupEffectSlot(Context, effectslot) == NULL)
 325             al_throwerr(Context, AL_INVALID_NAME);
 326         switch(param)
 327         {
 328         default:
 329             al_throwerr(Context, AL_INVALID_ENUM);
 330         }
 331     }
 332     al_endtry;
 333
 334     ALCcontext_DecRef(Context);
 335 }
 336
 337 AL_API ALvoid AL_APIENTRY alGetAuxiliaryEffectSlotf(ALuint effectslot, ALenum param, ALfloat *value)
 338 {
 339     ALCcontext *Context;
 340     ALeffectslot *Slot;
 341
 342     Context = GetContextRef();
 343     if(!Context) return;
 344
 345     al_try
 346     {
 347         if((Slot=LookupEffectSlot(Context, effectslot)) == NULL)
 348             al_throwerr(Context, AL_INVALID_NAME);
 349         switch(param)
 350         {
 351         case AL_EFFECTSLOT_GAIN:
 352             *value = Slot->Gain;
 353             break;
 354
 355         default:
 356             al_throwerr(Context, AL_INVALID_ENUM);
 357         }
 358     }
 359     al_endtry;
 360
 361     ALCcontext_DecRef(Context);
 362 }
 363
 364 AL_API ALvoid AL_APIENTRY alGetAuxiliaryEffectSlotfv(ALuint effectslot, ALenum param, ALfloat *values)
 365 {
 366     ALCcontext *Context;
 367
 368     switch(param)
 369     {
 370         case AL_EFFECTSLOT_GAIN:
 371             alGetAuxiliaryEffectSlotf(effectslot, param, values);
 372             return;
 373     }
 374
 375     Context = GetContextRef();
 376     if(!Context) return;
 377
 378     al_try
 379     {
 380         if(LookupEffectSlot(Context, effectslot) == NULL)
 381             al_throwerr(Context, AL_INVALID_NAME);
 382         switch(param)
 383         {
 384         default:
 385             al_throwerr(Context, AL_INVALID_ENUM);
 386         }
 387     }
 388     al_endtry;
 389
 390     ALCcontext_DecRef(Context);
 391 }
 392
 393
 394 static ALvoid NoneDestroy(ALeffectState *State)
 395 { free(State); }
 396 static ALboolean NoneDeviceUpdate(ALeffectState *State, ALCdevice *Device)
 397 {
 398     return AL_TRUE;
 399     (void)State;
 400     (void)Device;
 401 }
 402 static ALvoid NoneUpdate(ALeffectState *State, ALCdevice *Device, const ALeffectslot *Slot)
 403 {
 404     (void)State;
 405     (void)Device;
 406     (void)Slot;
 407 }
 408 static ALvoid NoneProcess(ALeffectState *State, ALuint SamplesToDo, const ALfloat *SamplesIn, ALfloat (*SamplesOut)[MaxChannels])
 409 {
 410     (void)State;
 411     (void)SamplesToDo;
 412     (void)SamplesIn;
 413     (void)SamplesOut;
 414 }
 415 ALeffectState *NoneCreate(void)
 416 {
 417     ALeffectState *state;
 418
 419     state = calloc(1, sizeof(*state));
 420     if(!state)
 421         return NULL;
 422
 423     state->Destroy = NoneDestroy;
 424     state->DeviceUpdate = NoneDeviceUpdate;
 425     state->Update = NoneUpdate;
 426     state->Process = NoneProcess;
 427
 428     return state;
 429 }
 430
 431
 432 static ALvoid RemoveEffectSlotArray(ALCcontext *Context, ALeffectslot *slot)
 433 {
 434     ALeffectslot **slotlist, **slotlistend;
 435
 436     LockContext(Context);
 437     slotlist = Context->ActiveEffectSlots;
 438     slotlistend = slotlist + Context->ActiveEffectSlotCount;
 439     while(slotlist != slotlistend)
 440     {
 441         if(*slotlist == slot)
 442         {
 443             *slotlist = *(--slotlistend);
 444             Context->ActiveEffectSlotCount--;
 445             break;
 446         }
 447         slotlist++;
 448     }
 449     UnlockContext(Context);
 450 }
 451
 452 static ALenum AddEffectSlotArray(ALCcontext *Context, ALsizei count, const ALuint *slots)
 453 {
 454     ALsizei i;
 455
 456     LockContext(Context);
 457     if(count > Context->MaxActiveEffectSlots-Context->ActiveEffectSlotCount)
 458     {
 459         ALsizei newcount;
 460         void *temp = NULL;
 461
 462         newcount = Context->MaxActiveEffectSlots ? (Context->MaxActiveEffectSlots<<1) : 1;
 463         if(newcount > Context->MaxActiveEffectSlots)
 464             temp = realloc(Context->ActiveEffectSlots,
 465                            newcount * sizeof(*Context->ActiveEffectSlots));
 466         if(!temp)
 467         {
 468             UnlockContext(Context);
 469             return AL_OUT_OF_MEMORY;
 470         }
 471         Context->ActiveEffectSlots = temp;
 472         Context->MaxActiveEffectSlots = newcount;
 473     }
 474     for(i = 0;i < count;i++)
 475     {
 476         ALeffectslot *slot = LookupEffectSlot(Context, slots[i]);
 477         assert(slot != NULL);
 478         Context->ActiveEffectSlots[Context->ActiveEffectSlotCount++] = slot;
 479     }
 480     UnlockContext(Context);
 481     return AL_NO_ERROR;
 482 }
 483
 484 ALenum InitializeEffect(ALCdevice *Device, ALeffectslot *EffectSlot, ALeffect *effect)
 485 {
 486     ALenum newtype = (effect ? effect->type : AL_EFFECT_NULL);
 487     ALeffectState *State = NULL;
 488     ALenum err = AL_NO_ERROR;
 489
 490     ALCdevice_Lock(Device);
 491     if(newtype == AL_EFFECT_NULL && EffectSlot->effect.type != AL_EFFECT_NULL)
 492     {
 493         State = NoneCreate();
 494         if(!State) err = AL_OUT_OF_MEMORY;
 495     }
 496     else if(newtype == AL_EFFECT_EAXREVERB || newtype == AL_EFFECT_REVERB)
 497     {
 498         if(EffectSlot->effect.type != AL_EFFECT_EAXREVERB && EffectSlot->effect.type != AL_EFFECT_REVERB)
 499         {
 500             State = ReverbCreate();
 501             if(!State) err = AL_OUT_OF_MEMORY;
 502         }
 503     }
 504     else if(newtype == AL_EFFECT_ECHO && EffectSlot->effect.type != AL_EFFECT_ECHO)
 505     {
 506         State = EchoCreate();
 507         if(!State) err = AL_OUT_OF_MEMORY;
 508     }
 509     else if(newtype == AL_EFFECT_RING_MODULATOR && EffectSlot->effect.type != AL_EFFECT_RING_MODULATOR)
 510     {
 511         State = ModulatorCreate();
 512         if(!State) err = AL_OUT_OF_MEMORY;
 513     }
 514     else if(newtype == AL_EFFECT_DEDICATED_DIALOGUE || newtype == AL_EFFECT_DEDICATED_LOW_FREQUENCY_EFFECT)
 515     {
 516         if(EffectSlot->effect.type != AL_EFFECT_DEDICATED_DIALOGUE && EffectSlot->effect.type != AL_EFFECT_DEDICATED_LOW_FREQUENCY_EFFECT)
 517         {
 518             State = DedicatedCreate();
 519             if(!State) err = AL_OUT_OF_MEMORY;
 520         }
 521     }
 522
 523     if(err != AL_NO_ERROR)
 524     {
 525         ALCdevice_Unlock(Device);
 526         return err;
 527     }
 528
 529     if(State)
 530     {
 531         int oldMode;
 532         oldMode = SetMixerFPUMode();
 533
 534         if(ALeffectState_DeviceUpdate(State, Device) == AL_FALSE)
 535         {
 536             RestoreFPUMode(oldMode);
 537             ALCdevice_Unlock(Device);
 538             ALeffectState_Destroy(State);
 539             return AL_OUT_OF_MEMORY;
 540         }
 541         State = ExchangePtr((XchgPtr*)&EffectSlot->EffectState, State);
 542
 543         if(!effect)
 544             memset(&EffectSlot->effect, 0, sizeof(EffectSlot->effect));
 545         else
 546             memcpy(&EffectSlot->effect, effect, sizeof(*effect));
 547         /* FIXME: This should be done asynchronously, but since the EffectState
 548          * object was changed, it needs an update before its Process method can
 549          * be called. */
 550         EffectSlot->NeedsUpdate = AL_FALSE;
 551         ALeffectState_Update(EffectSlot->EffectState, Device, EffectSlot);
 552         ALCdevice_Unlock(Device);
 553
 554         RestoreFPUMode(oldMode);
 555
 556         ALeffectState_Destroy(State);
 557         State = NULL;
 558     }
 559     else
 560     {
 561         if(!effect)
 562             memset(&EffectSlot->effect, 0, sizeof(EffectSlot->effect));
 563         else
 564             memcpy(&EffectSlot->effect, effect, sizeof(*effect));
 565         ALCdevice_Unlock(Device);
 566         EffectSlot->NeedsUpdate = AL_TRUE;
 567     }
 568
 569     return AL_NO_ERROR;
 570 }
 571
 572
 573 ALenum InitEffectSlot(ALeffectslot *slot)
 574 {
 575     ALint i;
 576
 577     if(!(slot->EffectState=NoneCreate()))
 578         return AL_OUT_OF_MEMORY;
 579
 580     slot->Gain = 1.0;
 581     slot->AuxSendAuto = AL_TRUE;
 582     slot->NeedsUpdate = AL_FALSE;
 583     for(i = 0;i < BUFFERSIZE;i++)
 584         slot->WetBuffer[i] = 0.0f;
 585     for(i = 0;i < 1;i++)
 586     {
 587         slot->ClickRemoval[i] = 0.0f;
 588         slot->PendingClicks[i] = 0.0f;
 589     }
 590     slot->ref = 0;
 591
 592     return AL_NO_ERROR;
 593 }
 594
 595 ALvoid ReleaseALAuxiliaryEffectSlots(ALCcontext *Context)
 596 {
 597     ALsizei pos;
 598     for(pos = 0;pos < Context->EffectSlotMap.size;pos++)
 599     {
 600         ALeffectslot *temp = Context->EffectSlotMap.array[pos].value;
 601         Context->EffectSlotMap.array[pos].value = NULL;
 602
 603         ALeffectState_Destroy(temp->EffectState);
 604
 605         FreeThunkEntry(temp->id);
 606         memset(temp, 0, sizeof(ALeffectslot));
 607         free(temp);
 608     }
 609 }