2 * Adplug - Replayer for many OPL2/OPL3 audio file formats.
3 * Copyright (C) 1999 - 2007 Simon Peter, <dn.tlp@gmx.net>, et al.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 * player.h - Replayer base class, by Simon Peter <dn.tlp@gmx.net>
22 #ifndef H_ADPLUG_PLAYER
23 #define H_ADPLUG_PLAYER
34 CPlayer(Copl *newopl);
37 /***** Operational methods *****/
38 void seek(unsigned long ms);
40 virtual bool load(const std::string &filename, // loads file
41 const CFileProvider &fp = CProvider_Filesystem()) = 0;
42 virtual bool update() = 0; // executes replay code for 1 tick
43 virtual void rewind(int subsong = -1) = 0; // rewinds to specified subsong
44 virtual float getrefresh() = 0; // returns needed timer refresh rate
46 /***** Informational methods *****/
47 unsigned long songlength(int subsong = -1);
49 virtual std::string gettype() = 0; // returns file type
50 virtual std::string gettitle() // returns song title
51 { return std::string(); }
52 virtual std::string getauthor() // returns song author name
53 { return std::string(); }
54 virtual std::string getdesc() // returns song description
55 { return std::string(); }
56 virtual unsigned int getpatterns() // returns number of patterns
58 virtual unsigned int getpattern() // returns currently playing pattern
60 virtual unsigned int getorders() // returns size of orderlist
62 virtual unsigned int getorder() // returns currently playing song position
64 virtual unsigned int getrow() // returns currently playing row
66 virtual unsigned int getspeed() // returns current song speed
68 virtual unsigned int getsubsongs() // returns number of subsongs
70 virtual unsigned int getsubsong() // returns current subsong
72 virtual unsigned int getinstruments() // returns number of instruments
74 virtual std::string getinstrument(unsigned int n) // returns n-th instrument name
75 { return std::string(); }
78 Copl *opl; // our OPL chip
79 CAdPlugDatabase *db; // AdPlug Database
81 static const unsigned short note_table[12]; // standard adlib note table
82 static const unsigned char op_table[9]; // the 9 operators as expected by the OPL