/*
   XMMS-SID - SIDPlay input plugin for X MultiMedia System (XMMS)

   libSIDPlay v2 and libSIDPlay v2-FP support

   Programmed and designed by Matti 'ccr' Hamalainen <ccr@tnsp.org>
   (C) Copyright 1999-2012 Tecnic Software productions (TNSP)

   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.
*/
#include "xmms-sid.h"

#ifdef HAVE_SIDPLAY2

#include <stdio.h>
#include "xs_sidplay2.h"
#include "xs_config.h"


#ifdef HAVE_SIDPLAY2_FP
#  include <sidplayfp/sidplay2.h>
#  include <sidplayfp/SidTune.h>
#else
#  include <sidplay/sidplay2.h>
#  include <sidplay/sidlazyiptr.h>
#  if G_BYTE_ORDER == G_BIG_ENDIAN
#    define SID2_NATIVE_UNSIGNED SID2_BIG_UNSIGNED
#    define SID2_NATIVE_SIGNED SID2_BIG_SIGNED
#  elif G_BYTE_ORDER == G_LITTLE_ENDIAN
#    define SID2_NATIVE_UNSIGNED SID2_LITTLE_UNSIGNED
#    define SID2_NATIVE_SIGNED SID2_LITTLE_SIGNED
#  else
#    error Unsupported endianess!
#  endif
#endif


class XSSIDPlay2 {
public:
#ifdef HAVE_SIDPLAY2_FP
    sidplay2 *currEng;
    sidbuilder *currBuilder;
#else
    SidIPtr<ISidplay2> currEng;
    SidLazyIPtr<ISidUnknown> currBuilder;
#endif
    sid2_config_t currConfig;
    SidTune *currTune;
    guint8 *buf;
    size_t bufSize;
    
    XSSIDPlay2(void);
    virtual ~XSSIDPlay2(void) { ; }
};


#ifdef HAVE_RESID_BUILDER
#  ifdef HAVE_SIDPLAY2_FP
#    include <sidplayfp/builders/resid.h>
#  else
#    include <sidplay/builders/resid.h>
#  endif
#endif

#ifdef HAVE_HARDSID_BUILDER
#  ifdef HAVE_SIDPLAY2_FP
#    include <sidplayfp/builders/hardsid.h>
#  else
#    include <sidplay/builders/hardsid.h>
#  endif
#endif


XSSIDPlay2::XSSIDPlay2(void)
#ifdef HAVE_SIDPLAY2_FP
:currEng(NULL)
#else
:currEng(sidplay2::create())
#endif
{
    buf = NULL;
    bufSize = 0;
    currTune = NULL;
    currBuilder = NULL;    
}


/* We need to 'export' all this pseudo-C++ crap */
extern "C" {


/* Return song information
 */
#define TFUNCTION   xs_sidplay2_getinfo
#define TFUNCTION2  xs_sidplay2_updateinfo
#define TTUNEINFO   SidTuneInfo
#define TTUNE       SidTune
#define TENGINE     XSSIDPlay2
#include "xs_sidplay.h"


/* Check if we can play the given file
 */
gboolean xs_sidplay2_probe(XSFile *f)
{
    gchar tmpBuf[5];
    
    if (!f) return FALSE;
    
    if (xs_fread(tmpBuf, sizeof(gchar), 4, f) != 4)
        return FALSE;
    
    if (!strncmp(tmpBuf, "PSID", 4) || !strncmp(tmpBuf, "RSID", 4))
        return TRUE;
    else
        return FALSE;
}


/* Initialize SIDPlay2
 */
gboolean xs_sidplay2_init(XSEngineState * state)
{
    gint i;
    XSSIDPlay2 *engine;
    sid_filter_t tmpFilter;
    xs_sid_filter_t *f;
    assert(state);

    /* Allocate internal structures */
    engine = new XSSIDPlay2();
    state->internal = engine;
    if (!engine) return FALSE;

    /* Initialize the engine */
#ifdef HAVE_SIDPLAY2_FP
    engine->currEng = new sidplay2;
#endif
    if (!engine->currEng) {
        xs_error("[SIDPlay2] Could not initialize emulation engine.\n");
        return FALSE;
    }

    /* Get current configuration */
    engine->currConfig = engine->currEng->config();

    /* Configure channels and stuff */
    switch (state->audioChannels) {
        case XS_CHN_AUTOPAN:
            engine->currConfig.playback = sid2_stereo;
            break;

        case XS_CHN_STEREO:
            engine->currConfig.playback = sid2_stereo;
            break;

        case XS_CHN_MONO:
        default:
            engine->currConfig.playback = sid2_mono;
            state->audioChannels = XS_CHN_MONO;
            break;
    }


    /* Memory mode settings */
    switch (xs_cfg.memoryMode) {
        case XS_MPU_BANK_SWITCHING:
            engine->currConfig.environment = sid2_envBS;
            break;

        case XS_MPU_TRANSPARENT_ROM:
            engine->currConfig.environment = sid2_envTP;
            break;

        case XS_MPU_PLAYSID_ENVIRONMENT:
            engine->currConfig.environment = sid2_envPS;
            break;

        case XS_MPU_REAL:
        default:
            engine->currConfig.environment = sid2_envR;
            xs_cfg.memoryMode = XS_MPU_REAL;
            break;
    }


    /* Audio parameters sanity checking and setup */
#ifdef HAVE_SIDPLAY2_FP
    state->audioBitsPerSample = XS_RES_16BIT;
    engine->currConfig.samplingMethod = SID2_RESAMPLE_INTERPOLATE;
#else
    engine->currConfig.precision = state->audioBitsPerSample;
#endif

    engine->currConfig.frequency = state->audioFrequency;


    switch (state->audioBitsPerSample) {
#ifndef HAVE_SIDPLAY2_FP
        case XS_RES_8BIT:
            state->audioFormat = FMT_U8;
            engine->currConfig.sampleFormat = SID2_LITTLE_UNSIGNED;
            break;
#endif

        case XS_RES_16BIT:
        default:
            state->audioFormat = FMT_S16_NE;
#ifndef HAVE_SIDPLAY2_FP
            switch (state->audioFormat) {
                case FMT_U16_LE:
                    engine->currConfig.sampleFormat = SID2_LITTLE_UNSIGNED;
                    break;

                case FMT_U16_BE:
                    engine->currConfig.sampleFormat = SID2_BIG_UNSIGNED;
                    break;

                case FMT_U16_NE:
                    engine->currConfig.sampleFormat = SID2_NATIVE_UNSIGNED;
                    break;

                case FMT_S16_LE:
                    engine->currConfig.sampleFormat = SID2_LITTLE_SIGNED;
                    break;

                case FMT_S16_BE:
                    engine->currConfig.sampleFormat = SID2_BIG_SIGNED;
                    break;

                default:
                    engine->currConfig.sampleFormat = SID2_NATIVE_SIGNED;
                    break;
        }
#endif
        break;
    }
    
    /* Convert filter */
    f = &(xs_cfg.sid2Filter);
    XSDEBUG("using filter '%s', %d points\n", f->name, f->npoints);
    if (f->npoints > XS_SIDPLAY2_NFPOINTS) {
        xs_error("[SIDPlay2] Invalid number of filter curve points (%d > %d)\n",
            f->npoints, XS_SIDPLAY2_NFPOINTS);
        f->npoints = XS_SIDPLAY2_NFPOINTS;
    }
    
    tmpFilter.points = f->npoints;
    for (i = 0; i < f->npoints; i++) {
        tmpFilter.cutoff[i][0] = f->points[i].x;
        tmpFilter.cutoff[i][1] = f->points[i].y;
    }

    /* Initialize builder object */
    XSDEBUG("init builder #%i, maxsids=%i\n", xs_cfg.sid2Builder, (engine->currEng->info()).maxsids);

#ifdef HAVE_RESID_BUILDER
    if (xs_cfg.sid2Builder == XS_BLD_RESID) {

#ifdef HAVE_SIDPLAY2_FP
        ReSIDBuilder *rs = new ReSIDBuilder("ReSID builder FP!");
        engine->currBuilder = (sidbuilder *) rs;
        if (rs) {
            rs->create((engine->currEng->info()).maxsids);
            if (!*rs) {
                xs_error("reSID->create() failed.\n");
                return FALSE;
            }
            rs->bias(0.0f);
        }
#else
        engine->currBuilder = ReSIDBuilderCreate("ReSID builder");
        SidLazyIPtr<IReSIDBuilder> rs(engine->currBuilder);
        if (rs) {
            engine->currConfig.sidEmulation = rs->iaggregate();
            rs->create((engine->currEng->info()).maxsids);
            if (!*rs) {
                xs_error("reSID->create() failed.\n");
                return FALSE;
            }

            rs->filter(xs_cfg.emulateFilters);
            if (!*rs) {
                xs_error("reSID->filter(%d) failed.\n", xs_cfg.emulateFilters);
                return FALSE;
            }

#if !defined(HAVE_SIDPLAY2_FP)
            // FIXME FIX ME: support other configurable parameters ...
            // ... WHEN/IF resid-builder+libsidplay2 gets fixed
            rs->sampling(tmpFreq);
            if (!*rs) {
                xs_error("reSID->sampling(%d) failed.\n", tmpFreq);
                return FALSE;
            }
            if (tmpFilter.points > 0)
                rs->filter((sid_filter_t *) &tmpFilter);
            else
#endif
                rs->filter((sid_filter_t *) NULL);
            
            if (!*rs) {
                xs_error("reSID->filter(NULL) failed.\n");
                return FALSE;
            }
        }
#endif
    }
#endif

#ifdef HAVE_HARDSID_BUILDER
    if (xs_cfg.sid2Builder == XS_BLD_HARDSID) {
#ifdef HAVE_SIDPLAY2_FP
        HardSIDBuilder *hs = new HardSIDBuilder("HardSID builder");
        engine->currBuilder = (sidbuilder *) hs;
        if (hs) {
#else
        engine->currBuilder = HardSIDBuilderCreate("");
        SidLazyIPtr<IHardSIDBuilder> hs(engine->currBuilder);
        if (hs) {
            engine->currConfig.sidEmulation = hs->iaggregate();
#endif
            /* Builder object created, initialize it */
            hs->create((engine->currEng->info()).maxsids);
            if (!*hs) {
                xs_error("hardSID->create() failed.\n");
                return FALSE;
            }

            hs->filter(xs_cfg.emulateFilters);
            if (!*hs) {
                xs_error("hardSID->filter(%d) failed.\n", xs_cfg.emulateFilters);
                return FALSE;
            }
        }
    }
#endif

    if (!engine->currBuilder) {
        xs_error("[SIDPlay2] Could not initialize SIDBuilder object.\n");
        return FALSE;
    }

#ifdef HAVE_SIDPLAY2_FP
    engine->currConfig.sidEmulation = engine->currBuilder;
    XSDEBUG("%s\n", engine->currBuilder->credits());
#endif

    /* Clockspeed settings */
    switch (xs_cfg.clockSpeed) {
    case XS_CLOCK_NTSC:
        engine->currConfig.clockDefault = SID2_CLOCK_NTSC;
        break;

    default:
        xs_error("[SIDPlay2] Invalid clockSpeed=%d, falling back to PAL.\n",
            xs_cfg.clockSpeed);

    case XS_CLOCK_PAL:
        engine->currConfig.clockDefault = SID2_CLOCK_PAL;
        xs_cfg.clockSpeed = XS_CLOCK_PAL;
        break;
    }


    /* Configure rest of the emulation */
    if (xs_cfg.forceSpeed) { 
        engine->currConfig.clockForced = true;
        engine->currConfig.clockSpeed = engine->currConfig.clockDefault;
    } else {
        engine->currConfig.clockForced = false;
        engine->currConfig.clockSpeed = SID2_CLOCK_CORRECT;
    }
    

#ifndef HAVE_SIDPLAY2_FP
    if (xs_cfg.sid2OptLevel < 0 || xs_cfg.sid2OptLevel > SID2_MAX_OPTIMISATION)
    {
        xs_error("Invalid sid2OptLevel=%d, falling back to %d.\n",
            xs_cfg.sid2OptLevel, SID2_DEFAULT_OPTIMISATION);
        
        xs_cfg.sid2OptLevel = SID2_DEFAULT_OPTIMISATION;
    }
    engine->currConfig.optimisation = xs_cfg.sid2OptLevel;
#endif

    if (xs_cfg.mos8580)
        engine->currConfig.sidDefault = SID2_MOS8580;
    else
        engine->currConfig.sidDefault = SID2_MOS6581;

    if (xs_cfg.forceModel)
        engine->currConfig.sidModel = engine->currConfig.sidDefault;
    else
        engine->currConfig.sidModel = SID2_MODEL_CORRECT;
    
    /* XXX: Should this be configurable? libSIDPlay1 does not support it, though */
    engine->currConfig.sidSamples = TRUE;


    /* Now set the emulator configuration */
    if (engine->currEng->config(engine->currConfig) < 0) {
        xs_error("[SIDPlay2] Emulator engine configuration failed!\n");
        return FALSE;
    }

    /* Create the sidtune */
    engine->currTune = new SidTune(0);
    if (!engine->currTune) {
        xs_error("[SIDPlay2] Could not initialize SIDTune object.\n");
        return FALSE;
    }

    return TRUE;
}


/* Close SIDPlay2 engine
 */
void xs_sidplay2_close(XSEngineState * state)
{
    XSSIDPlay2 *engine;
    assert(state);

    engine = (XSSIDPlay2 *) state->internal;

    /* Free internals */
    if (engine->currBuilder) {
#ifdef HAVE_SIDPLAY2_FP
        delete engine->currBuilder;
#endif
        engine->currBuilder = NULL;
    }

#ifdef HAVE_SIDPLAY2_FP
    if (engine->currEng) {
        delete engine->currEng;
        engine->currEng = NULL;
    }
#endif

    if (engine->currTune) {
        delete engine->currTune;
        engine->currTune = NULL;
    }

    xs_sidplay2_delete(state);

    delete engine;
    state->internal = NULL;
}


/* Initialize current song and sub-tune
 */
gboolean xs_sidplay2_initsong(XSEngineState * state)
{
    XSSIDPlay2 *engine;
    assert(state);

    engine = (XSSIDPlay2 *) state->internal;
    if (!engine) return FALSE;

    if (!engine->currTune->selectSong(state->currSong)) {
        xs_error("[SIDPlay2] currTune->selectSong() failed\n");
        return FALSE;
    }

    if (engine->currEng->load(engine->currTune) < 0) {
        xs_error("[SIDPlay2] currEng->load() failed\n");
        return FALSE;
    }
    
    state->isInitialized = TRUE;

    return TRUE;
}


/* Emulate and render audio data to given buffer
 */
guint xs_sidplay2_fillbuffer(XSEngineState * state, gchar * audioBuffer, guint audioBufSize)
{
    XSSIDPlay2 *engine;
    assert(state);

    engine = (XSSIDPlay2 *) state->internal;
    if (!engine) return 0;

    return engine->currEng->play((short *) audioBuffer, audioBufSize / sizeof(short));
}


/* Load a given SID-tune file
 */
gboolean xs_sidplay2_load(XSEngineState * state, gchar * pcFilename)
{
    XSSIDPlay2 *engine;
    assert(state);
    state->isInitialized = FALSE;

    engine = (XSSIDPlay2 *) state->internal;
    if (!engine) return FALSE;

    /* Try to get the tune */
    if (!pcFilename) return FALSE;

    if (xs_fload_buffer(pcFilename, &(engine->buf), &(engine->bufSize)) != 0)
        return FALSE;
    
    if (!engine->currTune->read(engine->buf, engine->bufSize))
        return FALSE;

    return TRUE;
}


/* Delete INTERNAL information
 */
void xs_sidplay2_delete(XSEngineState * state)
{
    XSSIDPlay2 *engine;
    assert(state);

    engine = (XSSIDPlay2 *) state->internal;
    if (!engine) return;
    
    g_free(engine->buf);
    engine->buf = NULL;
    engine->bufSize = 0;
}


/* Hardware backend flushing
 */
void xs_sidplay2_flush(XSEngineState * state)
{
    assert(state);

#ifdef HAVE_HARDSID_BUILDER
#ifdef HSID_SID2_COM
    IfPtr<HardSIDBuilder> hs(state->currBuilder);
    if (hs)
        hs->flush();
#else
    if (xs_cfg.sid2Builder == XS_BLD_HARDSID)
        ((HardSIDBuilder *) state->currBuilder)->flush();
#endif
#endif
}


}    /* extern "C" */
#endif    /* HAVE_SIDPLAY2 */