/*
  AdPlug - Replayer for many OPL2/OPL3 audio file formats.
  Copyright (C) 1999 - 2003 Simon Peter <dn.tlp@gmx.net>, et al.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

  xad.h - XAD shell player by Riven the Mage <riven@ok.ru>
*/

/*
 * Copyright (c) 2015 - 2017 Wraithverge <liam82067@yahoo.com>
 * - Realigned to Tabs.
 * - Added support for Speed indicator in 'File Info' dialogues.
 */

#ifndef H_ADPLUG_XAD
#define H_ADPLUG_XAD

#include "player.h"

class CxadPlayer: public CPlayer
{
public:
	static CPlayer *factory(Copl *newopl);

	CxadPlayer(Copl * newopl);
	~CxadPlayer();

	bool	load(const std::string &filename, const CFileProvider &fp) override;
	bool	update() override;
	void	rewind(int subsong) override;
	float	getrefresh() override;

	std::string     gettype() override;
	std::string     gettitle() override;
	std::string     getauthor() override;
	std::string     getinstrument(unsigned int i) override;
	unsigned int    getinstruments() override;

	// Wraithverge: added this.
	unsigned int    getspeed() override;

protected:
	virtual void xadplayer_rewind(int subsong) = 0;
	virtual bool xadplayer_load() = 0;
	virtual void xadplayer_update() = 0;
	virtual float xadplayer_getrefresh() = 0;
	virtual std::string xadplayer_gettype() = 0;
	virtual std::string xadplayer_gettitle()
	{
		return std::string(xad.title);
	}
	virtual std::string xadplayer_getauthor()
	{
		return std::string(xad.author);
	}
	virtual std::string xadplayer_getinstrument(unsigned int i)
	{
		return std::string("");
	}
	virtual unsigned int xadplayer_getinstruments()
	{
		return 0;
	}

	// Wraithverge: added this.
	virtual unsigned int xadplayer_getspeed()
	{
		return 0;
	}

	enum { HYP=1, PSI, FLASH, BMF, RAT, HYBRID };

	struct xad_header
	{
		unsigned long   id;
		char            title[36];
		char            author[36];
		unsigned short  fmt;
		unsigned char   speed;
		unsigned char   reserved_a;
	} xad;

	unsigned char * tune;
	unsigned long   tune_size;

	struct
	{
		int             playing;
		int             looping;
		unsigned char   speed;
		unsigned char   speed_counter;
	} plr;

	unsigned char   adlib[256];

	void opl_write(int reg, int val);
};
#endif
