libsidplayfp  0.3.5
Public Attributes
SidTuneInfo Struct Reference

#include <SidTune.h>

List of all members.

Public Attributes

const char * formatString
 the name of the identified file format
const char * statusString
 error/status message of last operation
const char * speedString
 describing the speed a song is running at
uint_least16_t loadAddr
uint_least16_t initAddr
uint_least16_t playAddr
uint_least16_t songs
uint_least16_t startSong
uint_least16_t currentSong
uint_least8_t songSpeed
 intended speed, see top
uint_least8_t clockSpeed
 -"-
uint_least8_t relocStartPage
 First available page for relocation.
uint_least8_t relocPages
 Number of pages available for relocation.
bool musPlayer
 whether Sidplayer routine has been installed
int sidModel1
 Sid Model required for first sid.
int sidModel2
 Sid Model required for second sid.
int compatibility
 compatibility requirements
bool fixLoad
 whether load address might be duplicate
uint_least16_t songLength
 — not yet supported —
uint_least8_t numberOfInfoStrings
char * infoString [SIDTUNE_MAX_CREDIT_STRINGS]
 the number of available text info lines
uint_least16_t numberOfCommentStrings
 — not yet supported —
char ** commentString
 — not yet supported —
uint_least32_t dataFileLen
 length of single-file sidtune file
uint_least32_t c64dataLen
 length of raw C64 data without load address
char * path
 path to sidtune files; "", if cwd
char * dataFileName
 a first file: e.g. "foo.c64"; "", if none
char * infoFileName
 a second file: e.g. "foo.sid"; "", if none
Base addresses

The SID chip base address(es) used by the sidtune.

uint_least16_t sidChipBase1
 0xD400 (normal, 1st SID)
uint_least16_t sidChipBase2
 0xD?00 (2nd SID) or 0 (no 2nd SID)

Detailed Description

An instance of this structure is used to transport values to and from SidTune objects.

You must read (i.e. activate) sub-song specific information via: const SidTuneInfo& tuneInfo = SidTune[songNumber]; const SidTuneInfo& tuneInfo = SidTune.getInfo(); void SidTune.getInfo(tuneInfo&);

Consider the following fields as read-only, because the SidTune class does not provide an implementation of: bool setInfo(const SidTuneInfo&). Currently, the only way to get the class to accept values which are written to these fields is by creating a derived class.


Member Data Documentation

uint_least16_t SidTuneInfo::currentSong

Available after song initialization. the one that has been initialized

uint_least8_t SidTuneInfo::numberOfInfoStrings

Song title, credits, ... 0 = Title, 1 = Author, 2 = Copyright/Publisher


The documentation for this struct was generated from the following file: