sample_group.hxx

Go to the documentation of this file.

// sample_group.hxx -- Manage a group of samples relative to a base position
//
// Written for the new SoundSystem by Erik Hofman, October 2009
//
// Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// $Id: sample__group_8hxx_source.html,v 1.3 2010/02/23 22:10:16 curt Exp $

#ifndef _SG_SAMPLE_GROUP_OPENAL_HXX
#define _SG_SAMPLE_GROUP_OPENAL_HXX 1

#ifndef __cplusplus
# error This library requires C++
#endif

#if defined(__APPLE__)
# include <OpenAL/al.h>
#elif defined(OPENALSDK)
# include <al.h>
#else
# include <AL/al.h>
#endif

#include <string>
#include <vector>
#include <map>

#include <simgear/compiler.h>
#include <simgear/math/SGMath.hxx>
#include <simgear/structure/SGReferenced.hxx>
#include <simgear/structure/SGSharedPtr.hxx>
#include <simgear/structure/exception.hxx>

#include "sample_openal.hxx"

using std::map;
using std::string;

typedef map < string, SGSharedPtr<SGSoundSample> > sample_map;
typedef sample_map::iterator sample_map_iterator;
typedef sample_map::const_iterator const_sample_map_iterator;

class SGSoundMgr;

class SGSampleGroup : public SGReferenced
{
public:

    SGSampleGroup ();

    SGSampleGroup ( SGSoundMgr *smgr, const string &refname );

    ~SGSampleGroup ();

    inline void activate() { _active = true; }

    virtual void update (double dt);

    bool add( SGSharedPtr<SGSoundSample> sound, const string& refname );

    bool remove( const string& refname );

    bool exists( const string& refname );

    SGSoundSample *find( const string& refname );

    void stop();

    void suspend();

    void resume();

    bool play( const string& refname, bool looping );
    
    inline bool play_looped( const string& refname ) {
        return play( refname, true );
    }

    inline bool play_once( const string& refname ) {
        return play( refname, false );
    }

    bool is_playing( const string& refname );

    bool stop( const string& refname );

    void set_volume( float vol );

    void set_velocity( const SGVec3d& vel ) {
       _velocity = vel; _changed = true;
    }

    void set_position_geod( const SGGeod& pos ) {
        _base_pos = pos; _changed = true;
    }

    void set_orientation( const SGQuatd& ori ) {
        _orientation = ori; _changed = true;
    }

    void tie_to_listener() { _tied_to_listener = true; }

protected:
    SGSoundMgr *_smgr;
    string _refname;
    bool _active;

private:
    bool _changed;
    bool _pause;
    float _volume;
    bool _tied_to_listener;

    SGVec3d _velocity;
    SGGeod _base_pos;
    SGQuatd _orientation;

    sample_map _samples;
    std::vector< SGSharedPtr<SGSoundSample> > _removed_samples;

    bool testForALError(string s);
    bool testForError(void *p, string s);

    void update_pos_and_orientation();
    void update_sample_config( SGSoundSample *sound );
};

#endif // _SG_SAMPLE_GROUP_OPENAL_HXX

---