// This file is part of Glest <https://github.com/Glest>
//
// Copyright (C) 2018  The Glest team
//
// Glest is a fork of MegaGlest <https://megaglest.org/>
//
// 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 3 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, see <https://www.gnu.org/licenses/>

#ifndef _SHARED_SOUND_SOUNDPLAYER_H_
#define _SHARED_SOUND_SOUNDPLAYER_H_

#include "sound.h"
#include "data_types.h"
#include "leak_dumper.h"

using Shared::Platform::uint32;

namespace Shared {
	namespace Sound {

		// =====================================================
		//	class SoundPlayerParams
		// =====================================================

		class SoundPlayerParams {
		public:
			uint32 strBufferSize;
			uint32 strBufferCount;
			uint32 staticBufferCount;

			SoundPlayerParams();
		};

		// =====================================================
		//	class SoundPlayer  
		//
		//	Interface that every SoundPlayer will implement
		// =====================================================

		class SoundPlayer {
		protected:

			bool initOk;

		public:
			virtual ~SoundPlayer() {
				initOk = false;
			};
			virtual bool init(const SoundPlayerParams *params) = 0;
			virtual void end() = 0;
			virtual void play(StaticSound *staticSound, bool force = false) = 0;
			virtual	void play(StrSound *strSound, int64 fadeOn = 0) = 0;	//delay and fade in miliseconds
			virtual void stop(StrSound *strSound, int64 fadeOff = 0) = 0;
			virtual void stopAllSounds(int64 fadeOff = 0) = 0;
			virtual void updateStreams() = 0;
			virtual bool wasInitOk() const {
				return initOk;
			}
		};

	}
} //end namespace

#endif