////////////////////////////////////////////////////////////////////////////////
//    Scorched3D (c) 2000-2011, 2025, 2026
//
//    This file is part of Scorched3D.
//
//    Scorched3D 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.
//
//    Scorched3D 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.
////////////////////////////////////////////////////////////////////////////////

#ifndef __INCLUDE_LandscapeSound_hpp_INCLUDE__
#define __INCLUDE_LandscapeSound_hpp_INCLUDE__

#include <XML/XMLFile.hpp>
#include <string>
#include <vector>

class LandscapeSoundTiming
{
public:
	virtual ~LandscapeSoundTiming();

	virtual bool  readXML( XMLNode* node ) = 0;
	virtual float getNextEventTime()       = 0;
};

class LandscapeSoundTimingLooped : public LandscapeSoundTiming
{
public:
	virtual bool  readXML( XMLNode* node );
	virtual float getNextEventTime();
};

class LandscapeSoundTimingRepeat : public LandscapeSoundTiming
{
public:
	virtual bool  readXML( XMLNode* node );
	virtual float getNextEventTime();

protected:
	float min, max;
};

class LandscapeSoundItem
{
public:
	virtual ~LandscapeSoundItem();
};

class ObjectGroupEntryReference;

class LandscapeSoundPositionSetItem : public LandscapeSoundItem
{
public:
	LandscapeSoundPositionSetItem( ObjectGroupEntryReference* reference );
	virtual ~LandscapeSoundPositionSetItem();

	ObjectGroupEntryReference* getReference();

private:
	ObjectGroupEntryReference* reference_;
};

class VirtualSoundSource;

class LandscapeSoundPosition
{
public:
	virtual ~LandscapeSoundPosition();

	virtual bool readXML( XMLNode* node )                                            = 0;
	virtual bool setPosition( VirtualSoundSource* source, LandscapeSoundItem* data ) = 0;

	virtual int                 getInitCount();
	virtual LandscapeSoundItem* getInitData( int count );
};

class LandscapeSoundPositionAmbient : public LandscapeSoundPosition
{
public:
	virtual bool readXML( XMLNode* node );
	virtual bool setPosition( VirtualSoundSource* source, LandscapeSoundItem* data );
};

class LandscapeSoundPositionAbsoulte : public LandscapeSoundPosition
{
public:
	virtual bool readXML( XMLNode* node );
	virtual bool setPosition( VirtualSoundSource* source, LandscapeSoundItem* data );

protected:
	Vector position;
};

class LandscapeSoundPositionWater : public LandscapeSoundPosition
{
public:
	virtual bool readXML( XMLNode* node );
	virtual bool setPosition( VirtualSoundSource* source, LandscapeSoundItem* data );

protected:
	float falloff;
};

class LandscapeSoundPositionGroup : public LandscapeSoundPosition
{
public:
	virtual bool readXML( XMLNode* node );
	virtual bool setPosition( VirtualSoundSource* source, LandscapeSoundItem* data );

protected:
	std::string name;
	float       falloff;
};

class LandscapeSoundPositionSet : public LandscapeSoundPosition
{
public:
	virtual bool readXML( XMLNode* node );
	virtual bool setPosition( VirtualSoundSource* source, LandscapeSoundItem* data );

	virtual int                 getInitCount();
	virtual LandscapeSoundItem* getInitData( int count );

protected:
	std::string name;
	int         maxsounds;
};

class LandscapeSoundSound
{
public:
	virtual ~LandscapeSoundSound();

	virtual bool  readXML( XMLNode* node )                              = 0;
	virtual bool  play( VirtualSoundSource* source, float ambientGain ) = 0;
	virtual float getGain()                                             = 0;
};

class LandscapeSoundSoundFile : public LandscapeSoundSound
{
public:
	virtual bool  readXML( XMLNode* node );
	virtual bool  play( VirtualSoundSource* source, float ambientGain );
	virtual float getGain();

protected:
	std::vector< std::string > files;
	float                      gain;
	float                      referencedistance;
	float                      rolloff;
};

class LandscapeSoundType
{
public:
	LandscapeSoundType();
	virtual ~LandscapeSoundType();

	virtual bool readXML( XMLNode* node );

	LandscapeSoundPosition* position;
	LandscapeSoundTiming*   timing;
	LandscapeSoundSound*    sound;
};

#endif  // __INCLUDE_LandscapeSound_hpp_INCLUDE__
