160 lines
3.7 KiB
Plaintext
160 lines
3.7 KiB
Plaintext
/*
|
|
* This file is part of libsidplayfp, a SID player engine.
|
|
*
|
|
* Copyright 2011-2013 Leandro Nini <drfiemost@users.sourceforge.net>
|
|
* Copyright 2007-2010 Antti Lankila
|
|
* Copyright 2000-2001 Simon White
|
|
*
|
|
* 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 2 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, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef SIDBUILDER_H
|
|
#define SIDBUILDER_H
|
|
|
|
#include <set>
|
|
#include <string>
|
|
|
|
#include "sidplayfp/SidConfig.h"
|
|
|
|
namespace libsidplayfp
|
|
{
|
|
class sidemu;
|
|
class EventScheduler;
|
|
}
|
|
|
|
/**
|
|
* Base class for sid builders.
|
|
*/
|
|
class sidbuilder
|
|
{
|
|
protected:
|
|
typedef std::set<libsidplayfp::sidemu*> emuset_t;
|
|
|
|
private:
|
|
const char * const m_name;
|
|
|
|
protected:
|
|
std::string m_errorBuffer;
|
|
|
|
emuset_t sidobjs;
|
|
|
|
bool m_status;
|
|
|
|
protected:
|
|
/**
|
|
* Utility class for setting emu parameters in builders.
|
|
*/
|
|
template<class Temu, typename Tparam>
|
|
class applyParameter
|
|
{
|
|
protected:
|
|
Tparam m_param;
|
|
void (Temu::*m_method)(Tparam);
|
|
|
|
public:
|
|
applyParameter(void (Temu::*method)(Tparam), Tparam param) :
|
|
m_param(param),
|
|
m_method(method) {}
|
|
void operator() (libsidplayfp::sidemu *e) { (static_cast<Temu*>(e)->*m_method)(m_param); }
|
|
};
|
|
|
|
public:
|
|
sidbuilder(const char * const name) :
|
|
m_name(name),
|
|
m_errorBuffer("N/A"),
|
|
m_status(true) {}
|
|
virtual ~sidbuilder() {}
|
|
|
|
/**
|
|
* The number of used devices.
|
|
*
|
|
* @return number of used sids, 0 if none.
|
|
*/
|
|
unsigned int usedDevices() const { return sidobjs.size(); }
|
|
|
|
/**
|
|
* Available devices.
|
|
*
|
|
* @return the number of available sids, 0 = endless.
|
|
*/
|
|
virtual unsigned int availDevices() const = 0;
|
|
|
|
/**
|
|
* Create the sid emu.
|
|
*
|
|
* @param sids the number of required sid emu
|
|
* @return the number of actually created sid emus
|
|
*/
|
|
virtual unsigned int create(unsigned int sids) = 0;
|
|
|
|
/**
|
|
* Find a free SID of the required specs
|
|
*
|
|
* @param env the event context
|
|
* @param model the required sid model
|
|
* @return pointer to the locked sid emu
|
|
*/
|
|
libsidplayfp::sidemu *lock(libsidplayfp::EventScheduler *scheduler, SidConfig::sid_model_t model);
|
|
|
|
/**
|
|
* Release this SID.
|
|
*
|
|
* @param device the sid emu to unlock
|
|
*/
|
|
void unlock(libsidplayfp::sidemu *device);
|
|
|
|
/**
|
|
* Remove all SID emulations.
|
|
*/
|
|
void remove();
|
|
|
|
/**
|
|
* Get the builder's name.
|
|
*
|
|
* @return the name
|
|
*/
|
|
const char *name() const { return m_name; }
|
|
|
|
/**
|
|
* Error message.
|
|
*
|
|
* @return string error message.
|
|
*/
|
|
const char *error() const { return m_errorBuffer.c_str(); }
|
|
|
|
/**
|
|
* Determine current state of object.
|
|
*
|
|
* @return true = okay, false = error
|
|
*/
|
|
bool getStatus() const { return m_status; }
|
|
|
|
/**
|
|
* Get the builder's credits.
|
|
*
|
|
* @return credits
|
|
*/
|
|
virtual const char *credits() const = 0;
|
|
|
|
/**
|
|
* Toggle sid filter emulation.
|
|
*
|
|
* @param enable true = enable, false = disable
|
|
*/
|
|
virtual void filter(bool enable) = 0;
|
|
};
|
|
|
|
#endif // SIDBUILDER_H
|