system.hpp

/*
  ==============================================================================

    system.hpp
    Created: 27 Jan 2014 7:14:31pm
    Author:  yvan

  ==============================================================================
*/

#ifndef SYSTEM_H_INCLUDED
#define SYSTEM_H_INCLUDED

#include "headers/types.hpp"
#include "utils/vector.hpp"
#include "classes.hpp"

namespace YSE {

  typedef Flt(*occlusionFunc)(const Vec& source, const Vec& listener);

  class API system {
  public:
    system();
   ~system();

    Bool init();
    void update();
    void close();

    reverb & getGlobalReverb();

    // audio device
    //void  speakerPos(Int  nr, Flt angle);
    //Int   activeDevice();
    const std::vector<device> & getDevices();
    void openDevice(const deviceSetup & object, CHANNEL_TYPE conf = CT_AUTO);
    void closeCurrentDevice();

    // effects
    //void insideCave(Bool status);

    // sound occlusion
    /* you should provide your own function for occlusion checks.
      Assuming that your game uses physics, this is quite easy to implement.
      All you have to do is a raycast form the first to the second position and see
      if there are any objects inbetween that should occlude the sound and decide how
      much you want to occlude it.
    */
    system& occlusionCallback(Flt(*func)(const YSE::Vec&, const YSE::Vec&));
    occlusionFunc occlusionCallback();

    system & underWaterFX(const channel & target);
    system & setUnderWaterDepth(Flt value);


    // config
    //system& dopplerScale(Flt scale);  Flt dopplerScale();
    //system& distanceFactor(Flt factor); Flt distanceFactor();
    //system& rolloffScale(Flt scale);  Flt rolloffScale();
    system& maxSounds(Int value); Int maxSounds(); // the maximum amount of sounds that are actually used. If the number of sounds exeeds this, the least significant ones will be turned virtual

    // statistics
    Flt cpuLoad(); // cpu load of the audio steam (not the YSE update system)
    void sleep(UInt ms); // usefull for console applications if you don't want to run update at max speed
  private:
    Flt(*occlusionPtr)(const Vec& source, const Vec& listener);
  };

  API system & System();
}



#endif  // SYSTEM_H_INCLUDED