SidTuneInfo.h

/*
 * This file is part of libsidplayfp, a SID player engine.
 *
 *  Copyright 2011-2017 Leandro Nini
 *  Copyright 2007-2010 Antti Lankila
 *  Copyright 2000 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 SIDTUNEINFO_H
#define SIDTUNEINFO_H
 
#include <stdint.h>
 
#include "sidplayfp/siddefs.h"
 
class SID_EXTERN SidTuneInfo
{
public:
    typedef enum {
        CLOCK_UNKNOWN,
        CLOCK_PAL,
        CLOCK_NTSC,
        CLOCK_ANY
    } clock_t;
 
    typedef enum {
        SIDMODEL_UNKNOWN,
        SIDMODEL_6581,
        SIDMODEL_8580,
        SIDMODEL_ANY
    } model_t;
 
    typedef enum {
        COMPATIBILITY_C64,   
        COMPATIBILITY_PSID,  
        COMPATIBILITY_R64,   
        COMPATIBILITY_BASIC  
    } compatibility_t;
 
public:
    static const int SPEED_VBI = 0;
 
    static const int SPEED_CIA_1A = 60;
 
public:
    uint_least16_t loadAddr() const;
 
    uint_least16_t initAddr() const;
 
    uint_least16_t playAddr() const;
 
    unsigned int songs() const;
 
    unsigned int startSong() const;
 
    unsigned int currentSong() const;
 
    uint_least16_t sidChipBase(unsigned int i) const;
 
    int sidChips() const;
 
    int songSpeed() const;
 
    uint_least8_t relocStartPage() const;
 
    uint_least8_t relocPages() const;
 
    model_t sidModel(unsigned int i) const;
 
    compatibility_t compatibility() const;
 
    unsigned int numberOfInfoStrings() const;     
    const char* infoString(unsigned int i) const; 
 
    unsigned int numberOfCommentStrings() const;     
    const char* commentString(unsigned int i) const; 
 
    uint_least32_t dataFileLen() const;
 
    uint_least32_t c64dataLen() const;
 
    clock_t clockSpeed() const;
 
    const char* formatString() const;
 
    bool fixLoad() const;
 
    const char* path() const;
 
    const char* dataFileName() const;
 
    const char* infoFileName() const;
 
private:
    virtual uint_least16_t getLoadAddr() const =0;
 
    virtual uint_least16_t getInitAddr() const =0;
 
    virtual uint_least16_t getPlayAddr() const =0;
 
    virtual unsigned int getSongs() const =0;
 
    virtual unsigned int getStartSong() const =0;
 
    virtual unsigned int getCurrentSong() const =0;
 
    virtual uint_least16_t getSidChipBase(unsigned int i) const =0;
 
    virtual int getSidChips() const =0;
 
    virtual int getSongSpeed() const =0;
 
    virtual uint_least8_t getRelocStartPage() const =0;
 
    virtual uint_least8_t getRelocPages() const =0;
 
    virtual model_t getSidModel(unsigned int i) const =0;
 
    virtual compatibility_t getCompatibility() const =0;
 
    virtual unsigned int getNumberOfInfoStrings() const =0;
    virtual const char* getInfoString(unsigned int i) const =0;
 
    virtual unsigned int getNumberOfCommentStrings() const =0;
    virtual const char* getCommentString(unsigned int i) const =0;
 
    virtual uint_least32_t getDataFileLen() const =0;
 
    virtual uint_least32_t getC64dataLen() const =0;
 
    virtual clock_t getClockSpeed() const =0;
 
    virtual const char* getFormatString() const =0;
 
    virtual bool getFixLoad() const =0;
 
    virtual const char* getPath() const =0;
 
    virtual const char* getDataFileName() const =0;
 
    virtual const char* getInfoFileName() const =0;
 
protected:
    ~SidTuneInfo() {}
};
 
#endif  /* SIDTUNEINFO_H */