Files
simgear/simgear/sound/sample_queue.hxx
T

158 lines
4.1 KiB
C++

// queue.hxx -- Sample Queue encapsulation class
//
// based on sample.hxx
//
// Copyright (C) 2010 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$
/**
* \file audio sample.hxx
* Provides a sample queue encapsulation
*/
#ifndef _SG_QUEUE_HXX
#define _SG_QUEUE_HXX 1
#ifndef __cplusplus
# error This library requires C++
#endif
#include <string>
#include <vector>
#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 "sample_openal.hxx"
/**
* manages everything we need to know for an individual audio sample
*/
class SGSampleQueue : public SGSoundSample {
public:
/**
* Empty constructor, can be used to read data to the systems
* memory and not to the driver.
* @param freq sample frequentie of the samples
* @param format OpenAL format id of the data
*/
SGSampleQueue(int freq, int format = AL_FORMAT_MONO8);
/**
* Destructor
*/
~SGSampleQueue ();
/**
* Schedule this audio sample to stop playing.
*/
virtual void stop();
/**
* Queue new data for this audio sample
* @param data Pointer to a memory block containg this audio sample data.
* @param len length of the sample buffer in bytes
*/
void add( const void* smp_data, size_t len );
/**
* Set the source id of this source
* @param sid OpenAL source-id
*/
virtual void set_source(unsigned int sid);
/**
* Get the OpenAL source id of this source
* @return OpenAL source-id
*/
virtual inline unsigned int get_source() { return _source; }
/**
* Test if the source-id of this audio sample may be passed to OpenAL.
* @return true if the source-id is valid
*/
virtual inline bool is_valid_source() const { return _valid_source; }
/**
* Set the source-id of this audio sample to invalid.
*/
virtual inline void no_valid_source() { _valid_source = false; }
/**
* Test if the buffer-id of this audio sample may be passed to OpenAL.
* @return false for sample queue
*/
inline bool is_valid_buffer() const { return false; }
inline virtual bool is_queue() const { return true; }
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; // sample name
std::vector<unsigned int> _buffers;
unsigned int _buffer;
// configuration values
int _format;
int _freq;
// 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 _playing;
bool _changed;
string random_string();
};
#endif // _SG_QUEUE_HXX