soundInterface.hpp

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

    sound.h
    Created: 28 Jan 2014 11:50:15am
    Author:  yvan

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

#ifndef SOUNDINTERFACE_H_INCLUDED
#define SOUNDINTERFACE_H_INCLUDED

#include "../classes.hpp"
#include "../headers/defines.hpp"

#if defined PUBLIC_JUCE
#include "JuceHeader.h"
#endif

namespace YSE {
  namespace SOUND {

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

      // Sound interfaces cannot be copied. The implementation needs access to the 
      // interface object. To do this, the address of the interface must not change.
      interfaceObject(const interfaceObject&) = delete;

      interfaceObject& create(const char * fileName, channel * ch = nullptr, Bool loop = false, Flt volume = 1.0f, Bool streaming = false);

      interfaceObject& create(DSP::dspSourceObject &  dsp, channel * ch = nullptr, Flt volume = 1.0f);

      interfaceObject& create(SYNTH::interfaceObject &  synth, channel * ch = nullptr, Flt volume = 1.0f);


#if defined PUBLIC_JUCE

      interfaceObject& create(juce::InputStream * source, channel * ch = nullptr, Bool loop = false, Flt volume = 1.0f, Bool streaming = false);
#endif

      /*
       Checks if there is an implementation linked to this interface. You can use this for debugging, but safely assume
       this returns true for the lifetime of the interface. It's not needed to check against this function before
       using the interface.
      */
      Bool isValid();

      interfaceObject& setPosition(const Vec &v);

      Vec getPosition();

      interfaceObject& setSpread(Flt value);

      Flt getSpread();

      interfaceObject& setSpeed(Flt  value);

      Flt getSpeed();

      interfaceObject& setSize(Flt  value);

      Flt getSize();

      interfaceObject& setLooping(Bool value);

      Bool isLooping();

      interfaceObject& setVolume(Flt value, UInt time = 0);

      Flt getVolume();

      interfaceObject& fadeAndStop(UInt time);

      interfaceObject& play();

      Bool isPlaying();

      interfaceObject& pause();

      Bool isPaused();

      interfaceObject& stop();

      Bool isStopped();

      interfaceObject& toggle();

      interfaceObject& restart();

      interfaceObject& setTime(Flt value);

      Flt  getTime();

      UInt getLength(); // sound length in samples

      interfaceObject& setRelative(Bool value);

      Bool isRelative();

      interfaceObject& setDoppler(Bool value);

      Bool getDoppler();

      interfaceObject& set2D(Bool value);


      Bool is2D();

      Bool isStreaming();

      Bool isReady();

      interfaceObject& setOcclusion(Bool value);

      Bool getOcclusion();

      interfaceObject& moveTo(channel & target);

      interfaceObject& setDSP(DSP::dspObject * value); DSP::dspObject * getDSP(); // attach a dsp object to this sound

      

    private:
      implementationObject * pimpl;

      // These values keep the last set value and are used by getters
      // so that we don't have to query the implementation
      Vec  pos;
      Flt  spread;
      Flt  volume;
      Flt  speed;
      Flt  size;
      Bool loop;
      Bool relative;
      Bool doppler;
      Bool pan2D;
      Bool occlusion;

      UInt fadeAndStopTime;
      DSP::dspObject * dsp;
      channel * parent;

      // these are frequently updated by the implementation
      aBool streaming;
      aUInt length;
      aFlt  time;
      std::atomic<SOUND_STATUS> status; // what it is currently doing

      friend class SOUND::implementationObject;
    };
  }
}




#endif  // SOUND_H_INCLUDED