Sound_Source.h

Go to the documentation of this file.

/* This file is part of the Zenipex Library (zenilib).
 * Copyright (C) 2011 Mitchell Keith Bloch (bazald).
 *
 * zenilib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * zenilib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with zenilib.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ZENI_SOUND_SOURCE_H
#define ZENI_SOUND_SOURCE_H

#include <Zeni/Coordinate.h>
#include <Zeni/Error.h>
#include <Zeni/Sound.h>
#include <Zeni/Timer_HQ.h>
#include <Zeni/Vector3f.h>

#include <Zeni/Define.h>

namespace Zeni {

  class ZENI_AUDIO_DLL Sound_Source_Pool;

  class ZENI_AUDIO_DLL Sound_Source_HW {
    friend class ZENI_AUDIO_DLL Sound_Source_Pool;

    Sound_Source_HW(const Sound_Source_HW &rhs);
    Sound_Source_HW & operator=(const Sound_Source_HW &rhs);

    Sound_Source_HW(const ALuint &source = AL_NONE);
    Sound_Source_HW(const Sound_Buffer &buffer,
                    const float &pitch = ZENI_DEFAULT_PITCH,
                    const float &gain = ZENI_DEFAULT_GAIN,
                    const Point3f &position = Point3f(),
                    const Vector3f &velocity = Vector3f(),
                    const bool &looping = false);
    ~Sound_Source_HW();

    static Sound_Source_HW * Try_Construct();

  public:
    enum STATE {STOPPED, PAUSED, PLAYING};

    void set_buffer(const Sound_Buffer &buffer); 
    void set_pitch(const float &pitch = ZENI_DEFAULT_PITCH); 
    void set_gain(const float &gain = ZENI_DEFAULT_GAIN); 
    void set_position(const Point3f &position); 
    void set_velocity(const Vector3f &velocity); 
    void set_looping(const bool &looping); 
    void set_time(const float &time); 
    void set_reference_distance(const float &reference_distance = ZENI_DEFAULT_REFERENCE_DISTANCE); // Set the near clamping distance
    void set_max_distance(const float &max_distance = ZENI_DEFAULT_MAX_SOUND_DISTANCE); // Set the far clamping distance
    void set_rolloff(const float &rolloff = ZENI_DEFAULT_ROLLOFF); // Set the maximum reduction in volume due to distance

    const Sound_Buffer & get_buffer() const; 
    float get_duration() const; 
    float get_pitch() const; 
    float get_gain() const; 
    Point3f get_position() const; 
    Vector3f get_velocity() const; 
    bool is_looping() const; 
    float get_time() const; 
    float get_reference_distance() const; // Get the near clamping distance
    float get_max_distance() const; // Get the far clamping distance
    float get_rolloff() const; // Get the maximum reduction in volume due to distance

    void play(); 
    void pause(); 
    void stop(); 

    STATE get_state() const; 
    bool is_playing() const; 
    bool is_paused() const; 
    bool is_stopped() const; 

  private:
    void init(const Sound_Buffer &buffer,
              const float &pitch = ZENI_DEFAULT_PITCH,
              const float &gain = ZENI_DEFAULT_GAIN,
              const Point3f &position = Point3f(),
              const Vector3f &velocity = Vector3f(),
              const bool &looping = false);
    void uninit();

#ifndef DISABLE_AL
    mutable ALuint m_source;
#endif
#ifdef ENABLE_SLES
    SLDataLocator_OutputMix loc_outmix;
    SLDataSink audioSnk;

    SLObjectItf fdPlayerObject;
    SLPlayItf fdPlayerPlay;
    SLSeekItf fdPlayerSeek;
    SLMuteSoloItf fdPlayerMuteSolo;
    SLVolumeItf fdPlayerVolume;
#endif

    mutable const Sound_Buffer * m_buffer;
  };

  class ZENI_AUDIO_DLL Sound_Source {
    friend class ZENI_AUDIO_DLL Sound_Source_Pool;

    Sound_Source(const Sound_Source &rhs);
    Sound_Source & operator=(const Sound_Source &rhs);

  public:
    Sound_Source();
    Sound_Source(const Sound_Buffer &buffer,
                                  const float &pitch = ZENI_DEFAULT_PITCH,
                                  const float &gain = ZENI_DEFAULT_GAIN,
                                  const Point3f &position = Point3f(),
                                  const Vector3f &velocity = Vector3f(),
                                  const bool &looping = false);
    ~Sound_Source();

    inline void set_priority(const int &priority = ZENI_DEFAULT_SOUND_PRIORITY); 
    inline void set_buffer(const Sound_Buffer &buffer); 
    inline void set_pitch(const float &pitch = ZENI_DEFAULT_PITCH); 
    inline void set_gain(const float &gain = ZENI_DEFAULT_GAIN); 
    inline void set_position(const Point3f &position); 
    inline void set_velocity(const Vector3f &velocity); 
    inline void set_looping(const bool &looping); 
    inline void set_time(const float &time); 
    inline void set_reference_distance(const float &reference_distance = ZENI_DEFAULT_REFERENCE_DISTANCE); // Set the near clamping distance
    inline void set_max_distance(const float &max_distance = ZENI_DEFAULT_MAX_SOUND_DISTANCE); // Set the far clamping distance
    inline void set_rolloff(const float &rolloff = ZENI_DEFAULT_ROLLOFF); // Set the maximum reduction in volume due to distance

    inline int get_priority() const; 
    inline Time_HQ get_unstop_time() const; 
    inline const Sound_Buffer & get_buffer() const; 
    inline float get_duration() const; 
    inline float get_pitch() const; 
    inline float get_gain() const; 
    inline Point3f get_position() const; 
    inline Vector3f get_velocity() const; 
    inline bool is_looping() const; 
    float get_time() const; 
    inline float get_reference_distance() const; // Get the near clamping distance
    inline float get_max_distance() const; // Get the far clamping distance
    inline float get_rolloff() const; // Get the maximum reduction in volume due to distance

    inline void play(); 
    inline void pause(); 
    inline void stop(); 

    inline bool is_playing() const; 
    inline bool is_paused() const; 
    inline bool is_stopped() const; 

    float calculate_gain(const Point3f &listener_position) const; 

    inline bool is_assigned() const; 

  private:
    void assign(Sound_Source_HW &hw);
    Sound_Source_HW * unassign();

    void update_state() const;
    void update_state(const Sound_Source_HW::STATE &state) const;

    Sound_Source_HW * m_hw;
    int m_priority;
    Time_HQ m_unstop_time;

    const Sound_Buffer * m_buffer;
    mutable float m_duration;
    float m_pitch;
    float m_gain;
    Point3f m_position;
    Vector3f m_velocity;
    bool m_looping;
    float m_reference_distance;
    float m_max_distance;
    float m_rolloff;

    mutable Time_HQ m_play_time;
    mutable float m_play_position;

    mutable bool m_playing;
    mutable bool m_paused;
    mutable bool m_stopped;

    bool m_remove_from_Pool_on_destruction;
  };

  struct ZENI_AUDIO_DLL Sound_Source_HW_Init_Failure : public Error {
    Sound_Source_HW_Init_Failure() : Error("Zeni Sound Source Hardware Failed to Initialize Correctly") {}
  };

}

#include <Zeni/Undefine.h>

#endif