sidplayfp Class Reference

#include <sidplayfp.h>

Public Member Functions
const SidConfig &	config () const
const SidInfo &	info () const
bool	config (const SidConfig &cfg)
const char *	error () const
bool	fastForward (unsigned int percent)
bool	load (SidTune *tune)
uint_least32_t	play (short *buffer, uint_least32_t count)
bool	isPlaying () const
void	stop ()
void	debug (bool enable, FILE *out)
void	mute (unsigned int sidNum, unsigned int voice, bool enable)
uint_least32_t	time () const
uint_least32_t	timeMs () const
void	setRoms (const uint8_t *kernal, const uint8_t *basic=0, const uint8_t *character=0)
uint_least16_t	getCia1TimerA () const

Detailed Description

sidplayfp

Examples

demo.cpp.

Member Function Documentation

config() [1/2]

const SidConfig & sidplayfp::config

(

)

const

Get the current engine configuration.

Returns

a const reference to the current configuration.

Examples

demo.cpp.

config() [2/2]

bool sidplayfp::config

(

const SidConfig &

cfg

)

Configure the engine. Check error for detailed message if something goes wrong.

Parameters

cfg	the new configuration

Returns

true on success, false otherwise.

debug()

void sidplayfp::debug	(	bool	enable,
		FILE *	out
	)

Control debugging. Only has effect if library have been compiled with the –enable-debug option.

Parameters

enable	enable/disable debugging.
out	the file where to redirect the debug info.

error()

const char * sidplayfp::error

(

)

const

Error message.

Returns

string error message.

Examples

demo.cpp.

fastForward()

bool sidplayfp::fastForward

(

unsigned int

percent

)

Set the fast-forward factor.

Parameters

percent

getCia1TimerA()

uint_least16_t sidplayfp::getCia1TimerA

(

)

const

Get the CIA 1 Timer A programmed value.

info()

const SidInfo & sidplayfp::info

(

)

const

Get the current player informations.

Returns

a const reference to the current info.

Examples

demo.cpp.

isPlaying()

bool sidplayfp::isPlaying

(

)

const

Check if the engine is playing or stopped.

Returns

true if playing, false otherwise.

load()

bool sidplayfp::load

(

SidTune *

tune

)

Load a tune. Check error for detailed message if something goes wrong.

Parameters

tune	the SidTune to load, 0 unloads current tune.

Returns

true on sucess, false otherwise.

Examples

demo.cpp.

mute()

void sidplayfp::mute	(	unsigned int	sidNum,
		unsigned int	voice,
		bool	enable
	)

Mute/unmute a SID channel.

Parameters

sidNum	the SID chip, 0 for the first one, 1 for the second.
voice	the channel to mute/unmute.
enable	true unmutes the channel, false mutes it.

play()

uint_least32_t sidplayfp::play	(	short *	buffer,
		uint_least32_t	count
	)

Run the emulation and produce samples to play if a buffer is given.

Parameters

buffer	pointer to the buffer to fill with samples.
count	the size of the buffer measured in 16 bit samples or 0 if no output is needed (e.g. Hardsid)

Returns

the number of produced samples. If less than requested and isPlaying() is true an error occurred, use error() to get a detailed message.

Examples

demo.cpp.

setRoms()

void sidplayfp::setRoms	(	const uint8_t *	kernal,
		const uint8_t *	basic = 0,
		const uint8_t *	character = 0
	)

Set ROM images.

Parameters

kernal	pointer to Kernal ROM.
basic	pointer to Basic ROM, generally needed only for BASIC tunes.
character	pointer to character generator ROM.

Examples

demo.cpp.

stop()

void sidplayfp::stop

(

)

Stop the engine.

time()

uint_least32_t sidplayfp::time

(

)

const

Get the current playing time.

Returns

the current playing time measured in seconds.

---

The documentation for this class was generated from the following files:

• sidplayfp.h
• sidplayfp.cpp