Sound.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_H
#define ZENI_SOUND_H

#include <Zeni/Error.h>
#include <Zeni/Singleton.h>
#include <Zeni/Sound_Buffer.h>
#include <Zeni/Sound_Renderer.h>
#include <Zeni/Sound_Stream_AL.h>

#include <Zeni/Define.h>

namespace Zeni {

  class ZENI_AUDIO_DLL Sound;

#ifdef _WINDOWS
  ZENI_AUDIO_EXT template class ZENI_AUDIO_DLL Singleton<Sound>;
#endif

  class ZENI_AUDIO_DLL Sound : public Singleton<Sound> {
    friend class Singleton<Sound>;

    static Sound * create();

    // Undefined
    Sound(const Sound &);
    Sound & operator=(const Sound &);

    Sound();
    virtual ~Sound();

  public:
    inline Sound_Renderer & get_Renderer(); 

    // Listener Functions
    void set_listener_position(const Point3f &position); 
    void set_listener_velocity(const Vector3f &velocity); 
    void set_listener_forward_and_up(const Vector3f &forward, const Vector3f &up); 
    void set_listener_gain(const float &gain); 
    void set_listener_muted(const bool &muted); 

    Point3f get_listener_position() const; 
    Vector3f get_listener_velocity() const; 
    std::pair<Vector3f, Vector3f> get_listener_forward_and_up() const; 
    inline float get_listener_gain() const; 
    inline bool is_listener_muted() const; 

    // BackGround Music Functions
    void set_BGM(const String &filename); 

    // BackGround Music Getter Functions
    inline bool playing_BGM(); 
    inline bool paused_BGM(); 
    inline bool stopped_BGM(); 
    inline float get_BGM_pitch(); 
    inline float get_BGM_gain(); 
    inline bool is_BGM_looping(); 
    inline float get_BGM_time(); 

    // BackGround Music Setter Functions
    inline void play_BGM(); 
    inline void pause_BGM(); 
    inline void stop_BGM(); 
    inline void set_BGM_pitch(const float &pitch); 
    inline void set_BGM_gain(const float &gain); 
    inline void set_BGM_looping(const bool &looping); 
    inline void set_BGM_time(const float &time); 

    Sound_Buffer & get_Hello_World_Buffer() const; 

    inline void update(); 

  private:
    Sound_Renderer *m_sound_renderer;
    mutable Sound_Buffer *m_hello_world_buffer;

    String m_bgmusic;
#ifdef DISABLE_AL
    Sound_Source & get_BGM_Source() const; 
    mutable Sound_Buffer *m_bgm;
#else
    void init_BGM_Sound_Stream_AL() const; 
    mutable Sound_Stream_AL *m_bgm;
#endif

    float m_listener_gain;
    bool m_listener_muted;
  };

  ZENI_AUDIO_DLL Sound & get_Sound(); 

  struct ZENI_AUDIO_DLL Sound_Init_Failure {
    Sound_Init_Failure() : msg("Zeni Sound Failed to Initialize Correctly") {}
    String msg;
  };

}

#include <Zeni/Undefine.h>

#endif