microphone.h

Go to the documentation of this file.

/*
 microphone.h
 Spatial Audio Library (SAL)
 Copyright (c) 2011, Enzo De Sena
 All rights reserved.
 
 Authors: Enzo De Sena, enzodesena@gmail.com
 
 */


#ifndef SAL_MICROPHONE_H
#define SAL_MICROPHONE_H

#include "point.h"
#include "source.h"
#include "quaternion.h"
#include <assert.h>
#include <map>
#include "salconstants.h"
#include "audiobuffer.h"

namespace sal {

class Microphone {
public:
  Microphone(mcl::Point position,
             mcl::Quaternion orientation = mcl::Quaternion::Identity());
  
  mcl::Point position() const noexcept;
  
  virtual void SetPosition(const mcl::Point& position) noexcept;
  
  mcl::Quaternion orientation() const noexcept;
  
  virtual void SetOrientation(const mcl::Quaternion& orientation) noexcept;
  
  void SetHandedness(const mcl::Handedness handedness) noexcept;
  
  void AddPlaneWave(const MonoBuffer& signal,
                    const mcl::Point& point,
                    Buffer& output_buffer) noexcept;
  
  void AddPlaneWave(const Sample* input_data,
                    const Int num_samples,
                    const mcl::Point& point,
                    Buffer& output_buffer) noexcept;
  
  void AddPlaneWave(const Sample input_sample,
                    const mcl::Point& point,
                    Buffer& output_buffer) noexcept;
  
  
  void AddPlaneWave(const MonoBuffer& input_buffer,
                    const mcl::Point& point,
                    const Int wave_id,
                    Buffer& output_buffer) noexcept;
  
  void AddPlaneWave(const Sample input_sample,
                    const mcl::Point& point,
                    const Int wave_id,
                    Buffer& output_buffer) noexcept;
  
  virtual void AddPlaneWave(const Sample* input_data,
                            const Int num_samples,
                            const mcl::Point& point,
                            const Int wave_id,
                            Buffer& output_buffer) noexcept;
  
  virtual bool IsCoincident() const noexcept = 0;
  
  virtual Int num_channels() const noexcept = 0;
  
  virtual bool IsOmni() const noexcept { return false; }
  
  mcl::Point GetRelativePoint(const mcl::Point& point) const noexcept;
  
  virtual void Reset() noexcept {}
  
  static bool Test();
  
  virtual ~Microphone() {}
  
  
  virtual void AddPlaneWaveRelative(const MonoBuffer& signal,
                                    const mcl::Point& point,
                                    const Int wave_id,
                                    Buffer& output_buffer) noexcept;
  
  virtual void AddPlaneWaveRelative(const Sample* input_data,
                                    const Int num_samples,
                                    const mcl::Point& point,
                                    const Int wave_id,
                                    Buffer& output_buffer) noexcept = 0;
  
private:
  mcl::Triplet position_;
  mcl::Quaternion orientation_;
  
  friend class MicrophoneArray;
protected:
  mcl::Handedness handedness_;
};

class StereoMicrophone : public Microphone {
public:
  StereoMicrophone(mcl::Point position, mcl::Quaternion orientation) :
      Microphone(position, orientation) {}
  
  virtual ~StereoMicrophone() {}
};
  
} // namespace sal

#endif