Files
scummvm-cursorfix/engines/ultima/nuvie/sound/adplug/adplug_player.h
2026-02-02 04:50:13 +01:00

100 lines
3.0 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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 <http://www.gnu.org/licenses/>.
*
*/
#ifndef NUVIE_SOUND_ADPLUG_ADPLUG_PLAYER
#define NUVIE_SOUND_ADPLUG_ADPLUG_PLAYER
#include "ultima/shared/std/string.h"
#include "ultima/nuvie/sound/adplug/opl.h"
namespace Common {
class Path;
}
namespace Ultima {
namespace Nuvie {
class CPlayer {
public:
CPlayer(Copl *newopl);
virtual ~CPlayer();
/***** Operational methods *****/
void seek(unsigned long ms);
virtual bool load(const Common::Path &filename) = 0; // loads file
virtual bool update() = 0; // executes replay code for 1 tick
virtual void rewind(int subsong = -1) = 0; // rewinds to specified subsong
virtual float getrefresh() = 0; // returns needed timer refresh rate
/***** Informational methods *****/
unsigned long songlength(int subsong = -1);
virtual Std::string gettype() = 0; // returns file type
virtual Std::string gettitle() { // returns song title
return Std::string();
}
virtual Std::string getauthor() { // returns song author name
return Std::string();
}
virtual Std::string getdesc() { // returns song description
return Std::string();
}
virtual unsigned int getpatterns() { // returns number of patterns
return 0;
}
virtual unsigned int getpattern() { // returns currently playing pattern
return 0;
}
virtual unsigned int getorders() { // returns size of orderlist
return 0;
}
virtual unsigned int getorder() { // returns currently playing song position
return 0;
}
virtual unsigned int getrow() { // returns currently playing row
return 0;
}
virtual unsigned int getspeed() { // returns current song speed
return 0;
}
virtual unsigned int getsubsongs() { // returns number of subsongs
return 1;
}
virtual unsigned int getinstruments() { // returns number of instruments
return 0;
}
virtual Std::string getinstrument(unsigned int n) { // returns n-th instrument name
return Std::string();
}
protected:
Copl *opl; // our OPL chip
static const unsigned short note_table[12]; // standard adlib note table
static const unsigned char op_table[9]; // the 9 operators as expected by the OPL2
};
} // End of namespace Nuvie
} // End of namespace Ultima
#endif