sample_openal.hxx

// sample_openal.hxx -- Audio sample encapsulation class
// 
// Written by Curtis Olson, started April 2004.
// Modified to match the new SoundSystem by Erik Hofman, October 2009
//
// Copyright (C) 2004  Curtis L. Olson - http://www.flightgear.org/~curt
// 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__openal_8hxx_source.html,v 1.3 2010/02/23 22:10:16 curt Exp $

#ifndef _SG_SAMPLE_HXX
#define _SG_SAMPLE_HXX 1

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

#include <string>

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

// #include <plib/sg.h>

class SGSoundSample : public SGReferenced {
public:

    SGSoundSample();

    SGSoundSample( const char *path, const char *file );

    SGSoundSample( void** data, int len, int freq, int format=AL_FORMAT_MONO8 );
    SGSoundSample( const unsigned char** data, int len, int freq,
                   int format = AL_FORMAT_MONO8 );

    ~SGSoundSample ();

    inline bool is_file() const { return _is_file; }

    bool has_changed() {
        bool b = _changed; _changed = false; return b;
    }

    bool has_static_data_changed() {
        bool b = _static_changed; _static_changed = false; return b;
    }

    void play( bool loop ) {
        _playing = true; _loop = loop; _changed = true;
    }

    inline bool is_looping() { return _loop; }

    void stop() {
        _playing = false; _changed = true;
    }

    inline void play_once() { play(false); }

    inline void play_looped() { play(true); }

    inline bool is_playing() { return _playing; }

    inline void set_data( const unsigned char **data ) {
        _data = (unsigned char*)*data; *data = NULL;
    }
    inline void set_data( void **data ) {
        _data = (unsigned char*)*data; *data = NULL;
    }

    inline void* get_data() const { return _data; }

    void free_data() {
        if ( _data != NULL ) free( _data ); _data = NULL;
    }

    void set_source(unsigned int sid) {
        _source = sid; _valid_source = true; _changed = true;
    }

    inline unsigned int get_source() { return _source; }

    inline bool is_valid_source() const { return _valid_source; }

    inline void no_valid_source() { _valid_source = false; }

    void set_buffer(unsigned int bid) {
        _buffer = bid; _valid_buffer = true; _changed = true;
    } 

    inline unsigned int get_buffer() { return _buffer; }

    inline bool is_valid_buffer() const { return _valid_buffer; }

    inline void no_valid_buffer() { _valid_buffer = false; }

    inline void set_pitch( float p ) {
        if (p > 2.0) p = 2.0; else if (p < 0.01) p = 0.01;
        _pitch = p; _changed = true;
    }

    inline float get_pitch() { return _pitch; }

    inline void set_master_volume( float v ) {
        if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
        _master_volume = v; _changed = true;
    }

    inline void set_volume( float v ) {
        if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
        _volume = v; _changed = true;
    }

    inline float get_volume() { return _volume * _master_volume; }

    inline void set_format( int format ) { _format = format; }

    inline int get_format() { return _format; }

    inline void set_frequency( int freq ) { _freq = freq; }

    inline int get_frequency() { return _freq; }

    inline void set_size( size_t size ) { _size = size; }

    inline size_t get_size() const { return _size; }

    inline void set_relative_position( const SGVec3f& pos ) {
        _relative_pos = toVec3d(pos); _changed = true;
    }

    inline void set_position( const SGVec3d& pos ) {
       _base_pos = pos; _changed = true;
    }

    SGVec3d& get_position() { return _absolute_pos; }

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

    inline void set_rotation( const SGQuatd& ec2body ) {
        _rotation = ec2body; _changed = true;
    }

    inline void set_direction( const SGVec3f& dir ) {
        _direction = toVec3d(dir); _static_changed = true;
    }

    void set_audio_cone( float inner, float outer, float gain ) {
        _inner_angle = inner; _outer_angle = outer; _outer_gain = gain;
        _static_changed = true;
    }

    SGVec3f& get_orientation() { return _orivec; }

    float get_innerangle() { return _inner_angle; }

    float get_outerangle() { return _outer_angle; }

    float get_outergain() { return _outer_gain; }

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

    SGVec3f& get_velocity() { return _velocity; }


    inline void set_reference_dist( float dist ) {
        _reference_dist = dist; _static_changed = true;
    }

    inline float get_reference_dist() { return _reference_dist; }


    inline void set_max_dist( float dist ) {
        _max_dist = dist; _static_changed = true;
    }

    inline float get_max_dist() { return _max_dist; }

    inline std::string get_sample_name() const { return _refname; }

    void update_pos_and_orientation();

private:

    // Position of the source sound.
    SGVec3d _absolute_pos;      // absolute position
    SGVec3d _relative_pos;      // position relative to the base position
    SGVec3d _direction;         // orientation offset
    SGVec3f _velocity;          // Velocity of the source sound.

    // The position and orientation of this sound
    SGQuatd _orientation;       // base orientation
    SGVec3f _orivec;            // orientation vector for OpenAL
    SGVec3d _base_pos;          // base position

    SGQuatd _rotation;

    std::string _refname;       // name or file path
    unsigned char* _data;

    // configuration values
    int _format;
    size_t _size;
    int _freq;

    // Buffers hold sound data.
    bool _valid_buffer;
    unsigned int _buffer;

    // Sources are points emitting sound.
    bool _valid_source;
    unsigned int _source;

    // The orientation of this sound (direction and cut-off angles)
    float _inner_angle;
    float _outer_angle;
    float _outer_gain;

    float _pitch;
    float _volume;
    float _master_volume;
    float _reference_dist;
    float _max_dist;
    bool _loop;

    bool _playing;
    bool _changed;
    bool _static_changed;
    bool _is_file;

    string random_string();
};


#endif // _SG_SAMPLE_HXX

---