de.quippy.sidplay.libsidplay.components.sidtune

Class SidTune

java.lang.Object

de.quippy.sidplay.libsidplay.components.sidtune.SidTune

public class SidTune
extends Object

Author:

Ken Händel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SidTune.Decompressed
static class	SidTune.LoadStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected Buffer_sidtt	cache
protected short[]	clockSpeed
protected static String[]	fileNameExtensions Filename extensions to append for various file types.
protected int	fileOffset For files with header: offset to real data
protected SidTuneInfo	info
protected String[]	infoString holds text info from the format headers etc.
protected int	musDataLen Needed for MUS/STR player installation.
static int	SIDTUNE_CLOCK_ANY
static int	SIDTUNE_CLOCK_NTSC
static int	SIDTUNE_CLOCK_PAL
static int	SIDTUNE_CLOCK_UNKNOWN
static int	SIDTUNE_COMPATIBILITY_BASIC File requires C64 Basic
static int	SIDTUNE_COMPATIBILITY_C64 File is C64 compatible
static int	SIDTUNE_COMPATIBILITY_PSID File is PSID specific
static int	SIDTUNE_COMPATIBILITY_R64 File is Real C64 only
static int	SIDTUNE_MAX_CREDIT_STRINGS
static int	SIDTUNE_MAX_CREDIT_STRLEN 80 characters plus terminating zero.
static int	SIDTUNE_MAX_FILELEN C64KB+LOAD+PSID
static int	SIDTUNE_MAX_MEMORY C64KB
static int	SIDTUNE_MAX_SONGS Also PSID file format limit.
static int	SIDTUNE_SIDMODEL_6581
static int	SIDTUNE_SIDMODEL_8580
static int	SIDTUNE_SIDMODEL_ANY
static int	SIDTUNE_SIDMODEL_UNKNOWN
static int	SIDTUNE_SPEED_CIA_1A CIA 1 Timer A
static int	SIDTUNE_SPEED_VBI Vertical-Blanking-Interrupt
protected short[]	songLength
protected short[]	songSpeed
protected boolean	status
protected static String	txt_badAddr
protected static String	txt_badReloc
protected static String	txt_cantCreateFile
protected static String	txt_cantLoadFile
protected static String	txt_cantOpenFile
protected static String	txt_CIA
protected static String	txt_corrupt
protected static String	txt_dataTooLong
protected static String	txt_empty
protected static String	txt_fileIoError
protected static String	txt_fileTooLong
protected static String	txt_na
protected static String	txt_noDataFile
protected static String	txt_noErrors
protected static String	txt_notEnoughMemory
protected static String	txt_songNumberExceed
protected static String	txt_unrecognizedFormat
protected static String	txt_VBI

Constructor Summary

Constructors

Constructor and Description
SidTune(short[] oneFileFormatSidtune, int sidtuneLength) Load a single-file sidtune from a memory buffer.
SidTune(String fileName, String[] fileNameExt) Load a sidtune from a file.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	bool() Determine current state of object (true = okay, false = error).
protected boolean	checkCompatibility() Check compatibility details are sensible
protected boolean	checkRelocInfo() Check for valid relocation information
protected void	convertOldStyleSpeedToTables(long speed, short clock) Convert 32-bit PSID-style speed word to internal tables.
protected int	convertPetsciiToAscii(SmartPtr_sidtt spPet, StringBuffer dest)
void	fixLoadAddress(boolean force, int init, int play) This function can be used to remove a duplicate C64 load address in the C64 data (example: FE 0F 00 10 4C ...).
SidTuneInfo	getInfo() Retrieve sub-song specific information.
boolean	getStatus() Determine current state of object (true = okay, false = error).
protected SidTune.LoadStatus	INFO_fileSupport(Buffer_sidtt dataBuf, Buffer_sidtt infoBuf)
boolean	isStereo() Whether sidtune uses two SID chips.
boolean	load(String fileName) Load a sidtune into an existing object.
boolean	loadFile(String fileName, Buffer_sidtt bufferRef) Does not affect status of object, and therefore can be used to load files.
protected boolean	MUS_detect(short[] buffer, int bufLen, Mus.Voice3Index voice3Index)
protected SidTune.LoadStatus	MUS_fileSupport(Buffer_sidtt musBuf, Buffer_sidtt strBuf)
protected void	MUS_installPlayer(short[] c64buf)
protected SidTune.LoadStatus	MUS_load(Buffer_sidtt musBuf, boolean init)
protected SidTune.LoadStatus	MUS_load(Buffer_sidtt musBuf, Buffer_sidtt strBuf, boolean init)
protected boolean	MUS_mergeParts(Buffer_sidtt musBuf, Buffer_sidtt strBuf)
protected void	MUS_setPlayerAddress()
SidTuneInfo	opGet(int songNum) Select sub-song (0 = default starting song) and retrieve active song information.
boolean	placeSidTuneInC64mem(short[] c64buf) Copy sidtune into C64 memory (64 KB).
protected SidTune.LoadStatus	PRG_fileSupport(String fileName, Buffer_sidtt dataBuf)
protected SidTune.LoadStatus	PSID_fileSupport(Buffer_sidtt dataBuf)
protected boolean	PSID_fileSupportSave(OutputStream toFile, short[] dataBuffer)
boolean	read(short[] sourceBuffer, int bufferLen) From a buffer.
protected boolean	resolveAddrs(short[] c64data, int fileOffset2) Common address resolution procedure
boolean	saveC64dataFile(String destFileName, boolean overWriteFlag)
boolean	savePSIDfile(String destFileName, boolean overWriteFlag)
boolean	saveSIDfile(String destFileName, boolean overWriteFlag)
boolean	saveToOpenFile(OutputStream toFile, short[] buffer, int bufferOffset, int bufLen)
int	selectSong(int selectedSong) Select sub-song (0 = default starting song) and return active song number out of [1,2,..
static void	setFileNameExtensions(String[] fileNameExt) The sidTune class does not copy the list of file name extensions, so make sure you keep it.
protected SidTune.LoadStatus	SID_fileSupport(Buffer_sidtt dataBuf, Buffer_sidtt sidBuf)
protected boolean	SID_fileSupportSave(OutputStream toFile)
protected SidTune.LoadStatus	X00_fileSupport(String fileName, Buffer_sidtt dataBuf)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SIDTUNE_MAX_SONGS

public static final int SIDTUNE_MAX_SONGS

Also PSID file format limit.

See Also:

Constant Field Values

SIDTUNE_MAX_CREDIT_STRINGS

public static final int SIDTUNE_MAX_CREDIT_STRINGS

See Also:

Constant Field Values

SIDTUNE_MAX_CREDIT_STRLEN

public static final int SIDTUNE_MAX_CREDIT_STRLEN

80 characters plus terminating zero.

See Also:

Constant Field Values

SIDTUNE_MAX_MEMORY

public static final int SIDTUNE_MAX_MEMORY

C64KB

See Also:

Constant Field Values

SIDTUNE_MAX_FILELEN

public static final int SIDTUNE_MAX_FILELEN

C64KB+LOAD+PSID

See Also:

Constant Field Values

SIDTUNE_SPEED_VBI

public static final int SIDTUNE_SPEED_VBI

Vertical-Blanking-Interrupt

See Also:

Constant Field Values

SIDTUNE_SPEED_CIA_1A

public static final int SIDTUNE_SPEED_CIA_1A

CIA 1 Timer A

See Also:

Constant Field Values

SIDTUNE_CLOCK_UNKNOWN

public static final int SIDTUNE_CLOCK_UNKNOWN

See Also:

Constant Field Values

SIDTUNE_CLOCK_PAL

public static final int SIDTUNE_CLOCK_PAL

See Also:

Constant Field Values

SIDTUNE_CLOCK_NTSC

public static final int SIDTUNE_CLOCK_NTSC

See Also:

Constant Field Values

SIDTUNE_CLOCK_ANY

public static final int SIDTUNE_CLOCK_ANY

See Also:

Constant Field Values

SIDTUNE_SIDMODEL_UNKNOWN

public static final int SIDTUNE_SIDMODEL_UNKNOWN

See Also:

Constant Field Values

SIDTUNE_SIDMODEL_6581

public static final int SIDTUNE_SIDMODEL_6581

See Also:

Constant Field Values

SIDTUNE_SIDMODEL_8580

public static final int SIDTUNE_SIDMODEL_8580

See Also:

Constant Field Values

SIDTUNE_SIDMODEL_ANY

public static final int SIDTUNE_SIDMODEL_ANY

See Also:

Constant Field Values

SIDTUNE_COMPATIBILITY_C64

public static final int SIDTUNE_COMPATIBILITY_C64

File is C64 compatible

See Also:

Constant Field Values

SIDTUNE_COMPATIBILITY_PSID

public static final int SIDTUNE_COMPATIBILITY_PSID

File is PSID specific

See Also:

Constant Field Values

SIDTUNE_COMPATIBILITY_R64

public static final int SIDTUNE_COMPATIBILITY_R64

File is Real C64 only

See Also:

Constant Field Values

SIDTUNE_COMPATIBILITY_BASIC

public static final int SIDTUNE_COMPATIBILITY_BASIC

File requires C64 Basic

See Also:

Constant Field Values

info

protected SidTuneInfo info

status

protected boolean status

songSpeed

protected short[] songSpeed

clockSpeed

protected short[] clockSpeed

songLength

protected short[] songLength

infoString

protected String[] infoString

holds text info from the format headers etc.

fileOffset

protected int fileOffset

For files with header: offset to real data

musDataLen

protected int musDataLen

Needed for MUS/STR player installation.

cache

protected Buffer_sidtt cache

fileNameExtensions

protected static String[] fileNameExtensions

Filename extensions to append for various file types.

txt_songNumberExceed

protected static final String txt_songNumberExceed

See Also:

Constant Field Values

txt_empty

protected static final String txt_empty

See Also:

Constant Field Values

txt_unrecognizedFormat

protected static final String txt_unrecognizedFormat

See Also:

Constant Field Values

txt_noDataFile

protected static final String txt_noDataFile

See Also:

Constant Field Values

txt_notEnoughMemory

protected static final String txt_notEnoughMemory

See Also:

Constant Field Values

txt_cantLoadFile

protected static final String txt_cantLoadFile

See Also:

Constant Field Values

txt_cantOpenFile

protected static final String txt_cantOpenFile

See Also:

Constant Field Values

txt_fileTooLong

protected static final String txt_fileTooLong

See Also:

Constant Field Values

txt_dataTooLong

protected static final String txt_dataTooLong

See Also:

Constant Field Values

txt_cantCreateFile

protected static final String txt_cantCreateFile

See Also:

Constant Field Values

txt_fileIoError

protected static final String txt_fileIoError

See Also:

Constant Field Values

txt_VBI

protected static final String txt_VBI

See Also:

Constant Field Values

txt_CIA

protected static final String txt_CIA

See Also:

Constant Field Values

txt_noErrors

protected static final String txt_noErrors

See Also:

Constant Field Values

txt_na

protected static final String txt_na

See Also:

Constant Field Values

txt_badAddr

protected static final String txt_badAddr

See Also:

Constant Field Values

txt_badReloc

protected static final String txt_badReloc

See Also:

Constant Field Values

txt_corrupt

protected static final String txt_corrupt

See Also:

Constant Field Values

Constructor Detail

SidTune

public SidTune(String fileName,
       String[] fileNameExt)

Load a sidtune from a file.
To retrieve data from standard input pass in filename "-". If you want to override the default filename extensions use this constructor. Please note, that if the specified ``sidTuneFileName'' does exist and the loader is able to determine its file format, this function does not try to append any file name extension. See ``SidTune.java'' for the default list of file name extensions. You can specific ``sidTuneFileName = 0'', if you do not want to load a sidtune. You can later load one with open().

Parameters:

fileName -

fileNameExt -

SidTune

public SidTune(short[] oneFileFormatSidtune,
       int sidtuneLength)

Load a single-file sidtune from a memory buffer. Currently supported:

• PSID format

Parameters:

oneFileFormatSidtune -

sidtuneLength -

Method Detail

setFileNameExtensions

public static void setFileNameExtensions(String[] fileNameExt)

The sidTune class does not copy the list of file name extensions, so make sure you keep it. If the provided pointer is 0, the default list will be activated. This is a static list which is used by all SidTune objects.

Parameters:

fileNameExt -

load

public boolean load(String fileName)

Load a sidtune into an existing object. From a file.

Parameters:

fileName -

Returns:

read

public boolean read(short[] sourceBuffer,
           int bufferLen)

From a buffer.

Parameters:

sourceBuffer -

bufferLen -

Returns:

opGet

public final SidTuneInfo opGet(int songNum)

Select sub-song (0 = default starting song) and retrieve active song information.

Parameters:

songNum -

Returns:

selectSong

public int selectSong(int selectedSong)

Select sub-song (0 = default starting song) and return active song number out of [1,2,..,SIDTUNE_MAX_SONGS].

Parameters:

selectedSong -

Returns:

getInfo

public final SidTuneInfo getInfo()

Retrieve sub-song specific information. Beware! Still member-wise copy!

Returns:

bool

public boolean bool()

Determine current state of object (true = okay, false = error). Upon error condition use ``getInfo'' to get a descriptive text string in ``SidTuneInfo.statusString''.

Returns:

getStatus

public boolean getStatus()

Determine current state of object (true = okay, false = error). Upon error condition use ``getInfo'' to get a descriptive text string in ``SidTuneInfo.statusString''.

Returns:

isStereo

public boolean isStereo()

Whether sidtune uses two SID chips.

Returns:

placeSidTuneInC64mem

public boolean placeSidTuneInC64mem(short[] c64buf)

Copy sidtune into C64 memory (64 KB).

Parameters:

c64buf -

Returns:

saveC64dataFile

public boolean saveC64dataFile(String destFileName,
                      boolean overWriteFlag)

Parameters:

destFileName -

overWriteFlag - true = Overwrite existing file, false = Default
One could imagine an "Are you sure ?"-checkbox before overwriting any file.

Returns:

true = Successful, false = Error condition. error when file already exists.

saveSIDfile

public boolean saveSIDfile(String destFileName,
                  boolean overWriteFlag)

Parameters:

destFileName -

overWriteFlag - true = Overwrite existing file, false = Default
One could imagine an "Are you sure ?"-checkbox before overwriting any file.

Returns:

true = Successful, false = Error condition. error when file already exists.

savePSIDfile

public boolean savePSIDfile(String destFileName,
                   boolean overWriteFlag)

Parameters:

destFileName -

overWriteFlag - true = Overwrite existing file, false = Default
One could imagine an "Are you sure ?"-checkbox before overwriting any file.

Returns:

true = Successful, false = Error condition. error when file already exists.

fixLoadAddress

public void fixLoadAddress(boolean force,
                  int init,
                  int play)

This function can be used to remove a duplicate C64 load address in the C64 data (example: FE 0F 00 10 4C ...). A duplicate load address of offset 0x02 is indicated by the ``fixLoad'' flag in the SidTuneInfo structure. The ``force'' flag here can be used to remove the first load address and set new INIT/PLAY addresses regardless of whether a duplicate load address has been detected and indicated by ``fixLoad''. For instance, some position independent sidtunes contain a load address of 0xE000, but are loaded to 0x0FFE and call the player code at 0x1000. Do not forget to save the sidtune file.

Parameters:

force -

init -

play -

loadFile

public boolean loadFile(String fileName,
               Buffer_sidtt bufferRef)

Does not affect status of object, and therefore can be used to load files. Error string is put into info.statusString, though.

Parameters:

fileName -

bufferRef -

Returns:

saveToOpenFile

public boolean saveToOpenFile(OutputStream toFile,
                     short[] buffer,
                     int bufferOffset,
                     int bufLen)

convertOldStyleSpeedToTables

protected void convertOldStyleSpeedToTables(long speed,
                                short clock)

Convert 32-bit PSID-style speed word to internal tables.

Parameters:

speed -

clock -

convertPetsciiToAscii

protected int convertPetsciiToAscii(SmartPtr_sidtt spPet,
                        StringBuffer dest)

checkCompatibility

protected boolean checkCompatibility()

Check compatibility details are sensible

Returns:

checkRelocInfo

protected boolean checkRelocInfo()

Check for valid relocation information

Returns:

resolveAddrs

protected boolean resolveAddrs(short[] c64data,
                   int fileOffset2)

Common address resolution procedure

Parameters:

c64data -

fileOffset2 -

Returns:

PSID_fileSupport

protected SidTune.LoadStatus PSID_fileSupport(Buffer_sidtt dataBuf)

PSID_fileSupportSave

protected boolean PSID_fileSupportSave(OutputStream toFile,
                           short[] dataBuffer)

SID_fileSupport

protected SidTune.LoadStatus SID_fileSupport(Buffer_sidtt dataBuf,
                                 Buffer_sidtt sidBuf)

SID_fileSupportSave

protected boolean SID_fileSupportSave(OutputStream toFile)

MUS_fileSupport

protected SidTune.LoadStatus MUS_fileSupport(Buffer_sidtt musBuf,
                                 Buffer_sidtt strBuf)

MUS_load

protected SidTune.LoadStatus MUS_load(Buffer_sidtt musBuf,
                          boolean init)

MUS_load

protected SidTune.LoadStatus MUS_load(Buffer_sidtt musBuf,
                          Buffer_sidtt strBuf,
                          boolean init)

MUS_detect

protected boolean MUS_detect(short[] buffer,
                 int bufLen,
                 Mus.Voice3Index voice3Index)

MUS_mergeParts

protected boolean MUS_mergeParts(Buffer_sidtt musBuf,
                     Buffer_sidtt strBuf)

MUS_setPlayerAddress

protected void MUS_setPlayerAddress()

MUS_installPlayer

protected void MUS_installPlayer(short[] c64buf)

INFO_fileSupport

protected SidTune.LoadStatus INFO_fileSupport(Buffer_sidtt dataBuf,
                                  Buffer_sidtt infoBuf)

PRG_fileSupport

protected SidTune.LoadStatus PRG_fileSupport(String fileName,
                                 Buffer_sidtt dataBuf)

X00_fileSupport

protected SidTune.LoadStatus X00_fileSupport(String fileName,
                                 Buffer_sidtt dataBuf)