SID.h

/*
 * This file is part of libsidplayfp, a SID player engine.
 *
 * Copyright 2011-2014 Leandro Nini <drfiemost@users.sourceforge.net>
 * Copyright 2007-2010 Antti Lankila
 * Copyright 2004 Dag Lem <resid@nimrod.no>
 *
 * 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 SIDFP_H
#define SIDFP_H
 
#include "siddefs-fp.h"
 
namespace reSIDfp
{
 
class Filter;
class Filter6581;
class Filter8580;
class ExternalFilter;
class Potentiometer;
class Voice;
class Resampler;
 
class SIDError
{
private:
    const char* message;
 
public:
    SIDError(const char* msg) :
        message(msg) {}
    const char* getMessage() { return message; }
};
 
class SID
{
private:
    static const int BUS_TTL;
 
    Filter* filter;
 
    Filter6581* filter6581;
 
    Filter8580* filter8580;
 
    ExternalFilter* externalFilter;
 
    Resampler* resampler;
 
    Potentiometer* potX;
 
    Potentiometer* potY;
 
    Voice* voice[3];
 
    int busValueTtl;
 
    int modelTTL;
 
    int nextVoiceSync;
 
    int delayedOffset;
 
    ChipModel model;
 
    unsigned char delayedValue;
 
    unsigned char busValue;
 
    bool muted[3];
 
private:
    void writeImmediate(int offset, unsigned char value);
 
    void ageBusValue(int n);
 
    int output() const;
 
    void voiceSync(bool sync);
 
public:
    SID();
    ~SID();
 
    void setChipModel(ChipModel model);
 
    ChipModel getChipModel() const { return model; }
 
    void reset();
 
    void input(int value);
 
    unsigned char read(int offset);
 
    void write(int offset, unsigned char value);
 
    void mute(int channel, bool enable) { muted[channel] = enable; }
 
    void setSamplingParameters(double clockFrequency, SamplingMethod method, double samplingFrequency, double highestAccurateFrequency);
 
    int clock(int cycles, short* buf);
 
    void clockSilent(int cycles);
 
    void setFilter6581Curve(double filterCurve);
 
    void setFilter8580Curve(double filterCurve);
 
    void enableFilter(bool enable);
};
 
} // namespace reSIDfp
 
#if RESID_INLINING || defined(SID_CPP)
 
#include <algorithm>
 
#include "Filter.h"
#include "ExternalFilter.h"
#include "Voice.h"
#include "resample/Resampler.h"
 
namespace reSIDfp
{
 
RESID_INLINE
void SID::ageBusValue(int n)
{
    if (likely(busValueTtl != 0))
    {
        busValueTtl -= n;
 
        if (unlikely(busValueTtl <= 0))
        {
            busValue = 0;
            busValueTtl = 0;
        }
    }
}
 
RESID_INLINE
int SID::output() const
{
    const int v1 = voice[0]->output(voice[2]->wave());
    const int v2 = voice[1]->output(voice[0]->wave());
    const int v3 = voice[2]->output(voice[1]->wave());
 
    return externalFilter->clock(filter->clock(v1, v2, v3));
}
 
 
RESID_INLINE
int SID::clock(int cycles, short* buf)
{
    ageBusValue(cycles);
    int s = 0;
 
    while (cycles != 0)
    {
        int delta_t = std::min(nextVoiceSync, cycles);
 
        if (likely(delta_t > 0))
        {
            if (unlikely(delayedOffset != -1))
            {
                delta_t = 1;
            }
 
            for (int i = 0; i < delta_t; i++)
            {
                /* clock waveform generators */
                voice[0]->wave()->clock();
                voice[1]->wave()->clock();
                voice[2]->wave()->clock();
 
                /* clock envelope generators */
                voice[0]->envelope()->clock();
                voice[1]->envelope()->clock();
                voice[2]->envelope()->clock();
 
                if (unlikely(resampler->input(output())))
                {
                    buf[s++] = resampler->getOutput();
                }
            }
 
            if (unlikely(delayedOffset != -1))
            {
                writeImmediate(delayedOffset, delayedValue);
                delayedOffset = -1;
            }
 
            cycles -= delta_t;
            nextVoiceSync -= delta_t;
        }
 
        if (unlikely(nextVoiceSync == 0))
        {
            voiceSync(true);
        }
    }
 
    return s;
}
 
} // namespace reSIDfp
 
#endif
 
#endif