/**
 * Furnace Tracker - multi-system chiptune tracker
 * Copyright (C) 2021-2024 tildearrow and contributors
 *
 * 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 _FMSHARED_BASE_H
#define _FMSHARED_BASE_H

#include "../dispatch.h"
#include "../instrument.h"
#include "../../fixedQueue.h"

#define KVS(x,y) ((chan[x].state.op[y].kvs==2 && isOutput[chan[x].state.alg][y]) || chan[x].state.op[y].kvs==1)

class DivPlatformFMBase: public DivDispatch {
  protected:
    const bool isOutput[8][4]={
      // 1     3     2    4
      {false,false,false,true},
      {false,false,false,true},
      {false,false,false,true},
      {false,false,false,true},
      {false,false,true ,true},
      {false,true ,true ,true},
      {false,true ,true ,true},
      {true ,true ,true ,true},
    };
    const unsigned char dtTable[8]={
      7,6,5,0,1,2,3,4
    };

    const int orderedOps[4]={
      0,2,1,3
    };

    const unsigned int hardResetCycles=127;

    struct FMChannel: public SharedChannel<int> {
      DivInstrumentFM state;
      unsigned char freqH, freqL;
      int portaPauseFreq;
      unsigned char opMask;
      signed char konCycles;
      bool hardReset, opMaskChanged;

      FMChannel():
        SharedChannel<int>(0),
        freqH(0),
        freqL(0),
        portaPauseFreq(0),
        opMask(15),
        konCycles(0),
        hardReset(false),
        opMaskChanged(false) {}
    };

    struct FMChannelStereo: public FMChannel {
      unsigned char pan;
      FMChannelStereo():
        FMChannel(),
        pan(3) {}
    };

    struct QueuedWrite {
      unsigned short addr;
      unsigned char val;
      bool addrOrVal;
      QueuedWrite(): addr(0), val(0), addrOrVal(false) {}
      QueuedWrite(unsigned short a, unsigned char v): addr(a), val(v), addrOrVal(false) {}
    };
    FixedQueue<QueuedWrite,2048> writes;

    unsigned char lastBusy;
    int delay;
    bool flushFirst;

    unsigned char regPool[512];
    short oldWrites[512];
    short pendingWrites[512];

    inline void rWrite(unsigned short a, short v) {
      if (!skipRegisterWrites) {
        pendingWrites[a]=v;
      }
    }
    inline void immWrite(unsigned short a, unsigned char v) {
      if (!skipRegisterWrites) {
        writes.push_back(QueuedWrite(a,v));
        if (dumpWrites) {
          addWrite(a,v);
        }
      }
    }
    // only used by OPN2 for DAC writes
    inline void urgentWrite(unsigned short a, unsigned char v) {
      if (!skipRegisterWrites && !flushFirst) {
        if (!writes.empty()) {
          // check for hard reset
          if (writes.front().addr==0xf0) {
            // replace hard reset with DAC write
            writes.pop_front();
          }
        }
        writes.push_front(QueuedWrite(a,v));
        if (dumpWrites) {
          addWrite(a,v);
        }
      }
    }
    
    virtual int mapVelocity(int ch, float vel) {
      // -0.75dB per step
      // -6: 64: 8
      // -12: 32: 16
      // -18: 16: 24
      // -24: 8: 32
      // -30: 4: 40
      // -36: 2: 48
      // -42: 1: 56
      if (vel==0) return 0;
      if (vel>=1.0) return 127;
      return CLAMP(round(128.0-(56.0-log2(vel*127.0)*8.0)),0,127);
    }

    bool getLegacyAlwaysSetVolume() {
      return true;
    }

    friend void putDispatchChan(void*,int,int);
  
    DivPlatformFMBase():
      DivDispatch(),
      lastBusy(0),
      delay(0),
      flushFirst(false) {}
};

#endif
