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