libsidplayfp  1.2.1
Public Member Functions | List of all members
sidplayfp Class Reference

#include <sidplayfp.h>

Public Member Functions

const SidConfigconfig () const
 
const SidInfoinfo () 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
 
void setRoms (const uint8_t *kernal, const uint8_t *basic=0, const uint8_t *character=0)
 
EventContextgetEventContext ()
 
uint_least16_t getCia1TimerA () const
 

Detailed Description

sidplayfp

Member Function Documentation

const SidConfig & sidplayfp::config ( ) const

Get the current engine configuration.

Returns
a const reference to the current configuration.
bool sidplayfp::config ( const SidConfig cfg)

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

Parameters
cfgthe new configuration
Returns
true on success, false otherwise.
void sidplayfp::debug ( bool  enable,
FILE *  out 
)

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

Parameters
enableenable/disable debugging.
outthe file where to redirect the debug info.
const char * sidplayfp::error ( ) const

Error message.

Returns
string error message.
bool sidplayfp::fastForward ( unsigned int  percent)

Set the fast-forward factor.

Parameters
percent
uint_least16_t sidplayfp::getCia1TimerA ( ) const

Get the CIA 1 Timer A programmed value.

EventContext * sidplayfp::getEventContext ( )

Get the event scheduler.

Returns
pointer to the scheduler.
const SidInfo & sidplayfp::info ( ) const

Get the current player informations.

Returns
a const reference to the current info.
bool sidplayfp::isPlaying ( ) const

Check if the engine is playing or stopped.

Returns
true if playing, false otherwise.
bool sidplayfp::load ( SidTune tune)

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

Parameters
tunethe SidTune to load, 0 unloads current tune.
Returns
true on sucess, false otherwise.
void sidplayfp::mute ( unsigned int  sidNum,
unsigned int  voice,
bool  enable 
)

Mute/unmute a SID channel.

Parameters
sidNumthe SID chip, 0 for the first one, 1 for the second.
voicethe channel to mute/unmute.
enabletrue unmutes the channel, false mutes it.
uint_least32_t sidplayfp::play ( short *  buffer,
uint_least32_t  count 
)

Produce samples to play.

Parameters
bufferpointer to the buffer to fill with samples.
countthe size of the buffer measured in 16 bit samples.
Returns
the number of produced samples.
void sidplayfp::setRoms ( const uint8_t *  kernal,
const uint8_t *  basic = 0,
const uint8_t *  character = 0 
)

Set ROMs. The ROMs are validate against known ones.

Parameters
kernalpointer to Kernal ROM.
basicpointer to Basic ROM, generally needed only for BASIC tunes.
characterpointer to character generator ROM.
void sidplayfp::stop ( )

Stop the engine.

uint_least32_t sidplayfp::time ( ) const

Get the current playing time with respect to resolution returned by timebase.

Returns
the current playing time.

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