al_Spatializer.hpp

#ifndef AL_SPATIALIZER_H
#define AL_SPATIALIZER_H
 
/*  Allocore --
    Multimedia / virtual environment application class library
 
    Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology,
   UCSB. Copyright (C) 2012-2015. The Regents of the University of California.
    All rights reserved.
 
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
 
        Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.
 
        Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
 
        Neither the name of the University of California nor the names of its
        contributors may be used to endorse or promote products derived from
        this software without specific prior written permission.
 
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
 
    File description:
    Spatializer base class
    File author(s):
    Lance Putnam, 2010, putnam.lance@gmail.com
    Graham Wakefield, 2010, grrrwaaa@gmail.com
    Ryan McGee, 2012, ryanmichaelmcgee@gmail.com
*/
 
#include <iostream>
 
#include "al/io/al_AudioIOData.hpp"
#include "al/sound/al_Speaker.hpp"
#include "al/spatial/al_Pose.hpp"
 
namespace al {
 
class Spatializer {
public:
  Spatializer(const Speakers &sl);
 
  virtual ~Spatializer() {}
 
  virtual void compile() {}
 
  virtual void prepare(AudioIOData &io) {}
 
  virtual void renderBuffer(AudioIOData &io, const Pose &listeningPose,
                            const float *samples,
                            const unsigned int &numFrames) = 0;
 
  virtual void renderSample(AudioIOData &io, const Pose &listeningPose,
                            const float &sample,
                            const unsigned int &frameIndex) = 0;
 
  virtual void finalize(AudioIOData &io) {}
 
  virtual void print(std::ostream &stream = std::cout) {}
 
  int numSpeakers() const { return int(mSpeakers.size()); }
 
  virtual void numFrames(unsigned int v) { mNumFrames = v; }
 
protected:
  Speakers mSpeakers;
 
  std::vector<float> mBuffer; // temporary frame buffer
  unsigned int mNumFrames{0};
};
 
} // namespace al
 
#endif