EffectsCalculator.cpp

Go to the documentation of this file.

/*
 * EffectsCalculator.cpp
 *
 *  Created on: 27.01.21
 *      Author: Jon Lidgard, Yannick Richter, Vincent Manoukian
 */
 
#include <stdint.h>
#include <math.h>
#include "EffectsCalculator.h"
#include "Axis.h"
#include "ledEffects.h"
 
 
#define EFFECT_STATE_INACTIVE 0
 
ClassIdentifier EffectsCalculator::info = {
          .name = "Effects" ,
          .id   = CLSID_EFFECTSCALC,
          .visibility = ClassVisibility::hidden
};
const ClassIdentifier EffectsCalculator::getInfo(){
    return info;
}
 
EffectsCalculator::EffectsCalculator() : CommandHandler("fx", CLSID_EFFECTSCALC),
        Thread("FXCalc", EFFECT_THREAD_MEM, EFFECT_THREAD_PRIO)
{
    restoreFlash();
 
    CommandHandler::registerCommands();
    registerCommand("filterCfFreq", EffectsCalculator_commands::ffbfiltercf, "Constant force filter frequency", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("filterCfQ", EffectsCalculator_commands::ffbfiltercf_q, "Constant force filter Q-factor", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("spring", EffectsCalculator_commands::spring, "Spring gain", CMDFLAG_GET | CMDFLAG_SET | CMDFLAG_INFOSTRING);
    registerCommand("friction", EffectsCalculator_commands::friction, "Friction gain", CMDFLAG_GET | CMDFLAG_SET | CMDFLAG_INFOSTRING);
    registerCommand("damper", EffectsCalculator_commands::damper, "Damper gain", CMDFLAG_GET | CMDFLAG_SET | CMDFLAG_INFOSTRING);
    registerCommand("inertia", EffectsCalculator_commands::inertia, "Inertia gain", CMDFLAG_GET | CMDFLAG_SET | CMDFLAG_INFOSTRING);
    registerCommand("effects", EffectsCalculator_commands::effects, "USed effects since reset (Info print as str). set 0 to reset", CMDFLAG_GET | CMDFLAG_SET | CMDFLAG_INFOSTRING);
    registerCommand("effectsDetails", EffectsCalculator_commands::effectsDetails, "List effects details. set 0 to reset", CMDFLAG_GET | CMDFLAG_SET  | CMDFLAG_STR_ONLY | CMDFLAG_GETADR);
    registerCommand("effectsForces", EffectsCalculator_commands::effectsForces, "List actual effects forces.", CMDFLAG_GET | CMDFLAG_GETADR);
//  registerCommand("monitorEffect", EffectsCalculator_commands::monitorEffect, "Get monitoring status. set to 1 to enable.", CMDFLAG_GET | CMDFLAG_SET);
 
    registerCommand("damper_f", EffectsCalculator_commands::damper_f, "Damper biquad freq", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("damper_q", EffectsCalculator_commands::damper_q, "Damper biquad q", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("friction_f", EffectsCalculator_commands::friction_f, "Friction biquad freq", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("friction_q", EffectsCalculator_commands::friction_q, "Friction biquad q", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("inertia_f", EffectsCalculator_commands::inertia_f, "Inertia biquad freq", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("inertia_q", EffectsCalculator_commands::inertia_q, "Inertia biquad q", CMDFLAG_GET | CMDFLAG_SET);
    registerCommand("filterProfile_id", EffectsCalculator_commands::filterProfileId, "Conditional effects filter profile: 0 default; 1 custom", CMDFLAG_GET | CMDFLAG_SET);
 
    registerCommand("frictionPctSpeedToRampup", EffectsCalculator_commands::frictionPctSpeedToRampup, "% of max speed for gradual increase", CMDFLAG_GET | CMDFLAG_SET);
 
    //this->Start(); // Enable if we want to periodically monitor
}
 
EffectsCalculator::~EffectsCalculator()
{
 
}
 
 
bool EffectsCalculator::isActive()
{
    return effects_active;
}
void EffectsCalculator::setActive(bool active)
{
    effects_active = active;
    for (uint8_t i = 0; i < effects_stats.size(); i++)
    {
        effects_stats[i].current = {0}; // Reset active effect forces
        effects_statslast[i].current = {0};
    }
    setClipLed(active);
}
 
 
/*
If the metric is less than CP Offset - Dead Band, then the resulting force is given by the following formula:
        force = Negative Coefficient * (q - (CP Offset – Dead Band))
Similarly, if the metric is greater than CP Offset + Dead Band, then the resulting force is given by the
following formula:
        force = Positive Coefficient * (q - (CP Offset + Dead Band))
A spring condition uses axis position as the metric.
A damper condition uses axis velocity as the metric.
An inertia condition uses axis acceleration as the metric.
 
 */
 
void EffectsCalculator::calculateEffects(std::vector<std::unique_ptr<Axis>> &axes)
{
    for (auto &axis : axes) {
        axis->setEffectTorque(0);
        axis->calculateAxisEffects(isActive());
    }
 
    if(!isActive()){
        return;
    }
 
    int32_t force = 0;
    int axisCount = axes.size();
    int32_t forces[MAX_AXIS] = {0};
 
    for (uint8_t i = 0; i < effects_stats.size(); i++)
    {
        effects_stats[i].current = {0}; // Reset active effect forces
    }
 
    for (uint8_t fxi = 0; fxi < MAX_EFFECTS; fxi++)
    {
        FFB_Effect *effect = &effects[fxi];
 
        // Effect activated and not infinite (0 or 0xffff)
        if (effect->state != EFFECT_STATE_INACTIVE && effect->duration != FFB_EFFECT_DURATION_INFINITE && effect->duration != 0){
            // Start delay not yet reached
            if(HAL_GetTick() < effect->startTime){
                continue;
            }
            // If effect has expired make inactive
            if (HAL_GetTick() - effect->startTime > effect->duration)
            {
                effect->state = EFFECT_STATE_INACTIVE;
                for(uint8_t axis=0 ; axis < axisCount ; axis++)
                    calcStatsEffectType(effect->type, 0,axis); // record a 0 on the ended force
            }
        }
 
        // Filter out inactive effects
        if (effect->state == EFFECT_STATE_INACTIVE)
        {
            continue;
        }
 
        force = calcNonConditionEffectForce(effect);
 
        for(uint8_t axis=0 ; axis < axisCount ; axis++) // Calculate effects for all axes
        {
            int32_t axisforce = calcComponentForce(effect, force, axes, axis);
            calcStatsEffectType(effect->type, axisforce,axis);
            forces[axis] += axisforce; // Do not clip yet to allow effects to subtract force correctly. Will not overflow as maxeffects * 0x7fff is less than int32 range
        }
    }
 
    // Apply summed force to axes
    for(uint8_t i=0 ; i < axisCount ; i++)
    {
        int32_t force = clip<int32_t, int32_t>(forces[i], -0x7fff, 0x7fff); // Clip
        axes[i]->setEffectTorque(force);
    }
 
    effects_statslast = effects_stats;
}
 
int32_t EffectsCalculator::calcNonConditionEffectForce(FFB_Effect *effect) {
    int32_t force_vector = 0;
    int32_t magnitude = effect->magnitude;
 
    // If using an envelope modulate the magnitude based on time
    if(effect->useEnvelope){
        magnitude = getEnvelopeMagnitude(effect);
    }
    switch (effect->type){
 
    case FFB_EFFECT_CONSTANT:
    { // Constant force is just the force
        force_vector = (int32_t)magnitude;
        break;
    }
 
    case FFB_EFFECT_RAMP:
    {
        uint32_t elapsed_time = HAL_GetTick() - effect->startTime;
        int32_t duration = effect->duration;
        force_vector = (int32_t)effect->startLevel + ((int32_t)elapsed_time * (effect->endLevel - effect->startLevel)) / duration;
        break;
    }
 
    case FFB_EFFECT_SQUARE:
    {
        uint32_t elapsed_time = HAL_GetTick() - effect->startTime;
        int32_t force = ((elapsed_time + effect->phase) % ((uint32_t)effect->period + 2)) < (uint32_t)(effect->period + 2) / 2 ? -magnitude : magnitude;
        force_vector = force + effect->offset;
        break;
    }
 
    case FFB_EFFECT_TRIANGLE:
    {
        int32_t force = 0;
        int32_t offset = effect->offset;
        uint32_t elapsed_time = HAL_GetTick() - effect->startTime;
        uint32_t phase = effect->phase;
        uint32_t period = effect->period;
        float periodF = period;
 
        int32_t maxMagnitude = offset + magnitude;
        int32_t minMagnitude = offset - magnitude;
        uint32_t phasetime = (phase * period) / 35999;
        uint32_t timeTemp = elapsed_time + phasetime;
        float remainder = timeTemp % period;
        float slope = ((maxMagnitude - minMagnitude) * 2) / periodF;
        if (remainder > (periodF / 2))
            force = slope * (periodF - remainder);
        else
            force = slope * remainder;
        force += minMagnitude;
        force_vector = force;
        break;
    }
 
    case FFB_EFFECT_SAWTOOTHUP:
    {
        float offset = effect->offset;
        uint32_t elapsed_time = HAL_GetTick() - effect->startTime;
        uint32_t phase = effect->phase;
        uint32_t period = effect->period;
        float periodF = effect->period;
 
        float maxMagnitude = offset + magnitude;
        float minMagnitude = offset - magnitude;
        int32_t phasetime = (phase * period) / 35999;
        uint32_t timeTemp = elapsed_time + phasetime;
        float remainder = timeTemp % period;
        float slope = (maxMagnitude - minMagnitude) / periodF;
        force_vector = (int32_t)(minMagnitude + slope * (period - remainder));
        break;
    }
 
    case FFB_EFFECT_SAWTOOTHDOWN:
    {
        float offset = effect->offset;
        uint32_t elapsed_time = HAL_GetTick() - effect->startTime;
        float phase = effect->phase;
        uint32_t period = effect->period;
        float periodF = effect->period;
 
        float maxMagnitude = offset + magnitude;
        float minMagnitude = offset - magnitude;
        int32_t phasetime = (phase * period) / 35999;
        uint32_t timeTemp = elapsed_time + phasetime;
        float remainder = timeTemp % period;
        float slope = (maxMagnitude - minMagnitude) / periodF;
        force_vector = (int32_t)(minMagnitude + slope * (remainder)); // reverse time
        break;
    }
 
    case FFB_EFFECT_SINE:
    {
        float t = HAL_GetTick() - effect->startTime;
        float freq = 1.0f / (float)(std::max<uint16_t>(effect->period, 2));
        float phase = (float)effect->phase / (float)35999; //degrees
        float sine = sinf(2.0 * M_PI * (t * freq + phase)) * magnitude;
        force_vector = (int32_t)(effect->offset + sine);
        break;
    }
    default:
        return 0;
        break;
    }
 
    return (force_vector * effect->gain) / 255;
}
 
 
 
int32_t EffectsCalculator::calcComponentForce(FFB_Effect *effect, int32_t forceVector, std::vector<std::unique_ptr<Axis>> &axes, uint8_t axis)
{
    int32_t result_torque = 0;
//  uint16_t direction;
    uint8_t con_idx = effect->useSingleCondition? 0 : axis; // condition block index
 
    metric_t *metrics = axes[axis]->getMetrics();
 
    float angle_ratio = effect->axisMagnitudes[axis];
 
    switch (effect->type)
    {
    case FFB_EFFECT_CONSTANT:
    {
        // Optional filtering to reduce spikes
        if(effect->filter[axis] != nullptr) {
            // if the filter is enabled we apply it
            if (effect->filter[axis]->getFc() < 0.5 && effect->filter[0]->getFc() != 0.0)
            {
                forceVector = effect->filter[axis]->process(forceVector);
            }
        }
    }
    // No break required here. The filter is a special preprocessing case for the constant force effect.
    case FFB_EFFECT_RAMP:
    case FFB_EFFECT_SQUARE:
    case FFB_EFFECT_TRIANGLE:
    case FFB_EFFECT_SAWTOOTHUP:
    case FFB_EFFECT_SAWTOOTHDOWN:
    case FFB_EFFECT_SINE:
    {
        result_torque = -forceVector * angle_ratio;
        break;
    }
 
    case FFB_EFFECT_SPRING:
    {
        float pos = metrics->pos;
        result_torque -= calcConditionEffectForce(effect, pos, gain.spring, con_idx, scaler.spring, angle_ratio);
        break;
    }
 
 
    case FFB_EFFECT_FRICTION: // TODO sometimes unstable.
    {
        float speed = metrics->speed * INTERNAL_SCALER_FRICTION;
 
        int16_t offset = effect->conditions[con_idx].cpOffset;
        int16_t deadBand = effect->conditions[con_idx].deadBand;
        int32_t force = 0;
 
        float speedRampupCeil = speedRampupPct();
 
        // Effect is only active outside deadband + offset
        if (abs((int32_t)speed - offset) > deadBand){
 
            // remove offset/deadband from metric to compute force
            speed -= (offset + (deadBand * (speed < offset ? -1 : 1)) );
 
            // check if speed is in the 0..x% to rampup, if is this range, apply a sinusoidale function to smooth the torque (slow near 0, slow around the X% rampup
            float rampupFactor = 1.0;
            if (fabs (speed) < speedRampupCeil) {                               // if speed in the range to rampup we apply a sinus curbe to ramup
 
                float phaseRad = M_PI * ((fabs (speed) / speedRampupCeil) - 0.5);// we start to compute the normalized angle (speed / normalizedSpeed@5%) and translate it of -1/2PI to translate sin on 1/2 periode
                rampupFactor = ( 1 + sin(phaseRad ) ) / 2;                      // sin value is -1..1 range, we translate it to 0..2 and we scale it by 2
 
            }
 
            int8_t sign = speed >= 0 ? 1 : -1;
            uint16_t coeff = speed < 0 ? effect->conditions[con_idx].negativeCoefficient : effect->conditions[con_idx].positiveCoefficient;
            force = coeff * rampupFactor * sign;
 
            //if there is a saturation, used it to clip result
            if (effect->conditions[con_idx].negativeSaturation !=0 || effect->conditions[con_idx].positiveSaturation !=0) {
                force = clip<int32_t, int32_t>(force, -effect->conditions[con_idx].negativeSaturation, effect->conditions[con_idx].positiveSaturation);
            }
 
            result_torque -= effect->filter[axis]->process( (((gain.friction + 1) * force) >> 8) * angle_ratio * scaler.friction);
        }
 
        break;
    }
    case FFB_EFFECT_DAMPER:
    {
 
        float speed = metrics->speed * INTERNAL_SCALER_DAMPER;
        result_torque -= effect->filter[axis]->process(calcConditionEffectForce(effect, speed, gain.damper, con_idx, scaler.damper, angle_ratio));
 
        break;
    }
 
    case FFB_EFFECT_INERTIA:
    {
        float accel = metrics->accel * INTERNAL_SCALER_INERTIA;
        result_torque -= effect->filter[axis]->process(calcConditionEffectForce(effect, accel, gain.inertia, con_idx, scaler.inertia, angle_ratio)); // Bump *60 the inertia feedback
 
        break;
    }
 
    default:
        // Unsupported effect
        break;
    }
    return (result_torque * global_gain) / 255; // Apply global gain
}
 
float EffectsCalculator::speedRampupPct() {
    return (frictionPctSpeedToRampup / 100.0) * 32767;  // compute the normalizedSpeed of pctToRampup factor
}
 
 
int32_t EffectsCalculator::calcConditionEffectForce(FFB_Effect *effect, float  metric, uint8_t gain,
                                         uint8_t idx, float scale, float angle_ratio)
{
    int16_t offset = effect->conditions[idx].cpOffset;
    int16_t deadBand = effect->conditions[idx].deadBand;
    int32_t force = 0;
    float gainfactor = (float)(gain+1) / 256.0;
 
    // Effect is only active outside deadband + offset
    if (abs(metric - offset) > deadBand){
        float coefficient = effect->conditions[idx].negativeCoefficient;
        if(metric > offset){
            coefficient = effect->conditions[idx].positiveCoefficient;
        }
        coefficient /= 0x7fff; // rescale the coefficient of effect
 
        // remove offset/deadband from metric to compute force
        metric = metric - (offset + (deadBand * (metric < offset ? -1 : 1)) );
 
        force = clip<int32_t, int32_t>((coefficient * gainfactor * scale * (float)(metric)),
                                        -effect->conditions[idx].negativeSaturation,
                                         effect->conditions[idx].positiveSaturation);
    }
 
 
    return force * angle_ratio;
}
 
int32_t EffectsCalculator::getEnvelopeMagnitude(FFB_Effect *effect)
{
    if(effect->duration == FFB_EFFECT_DURATION_INFINITE || effect->duration == 0){
        return effect->magnitude; // Effect is infinite. envelope is invalid
    }
    int32_t scaler = abs(effect->magnitude);
    uint32_t elapsed_time = HAL_GetTick() - effect->startTime;
    if (elapsed_time < effect->attackTime && effect->attackTime != 0)
    {
        scaler = (scaler - effect->attackLevel) * elapsed_time;
        scaler /= (int32_t)effect->attackTime;
        scaler += effect->attackLevel;
    }
    if (elapsed_time > (effect->duration - effect->fadeTime) && effect->fadeTime != 0)
    {
        scaler = (scaler - effect->fadeLevel) * (effect->duration - elapsed_time); // Reversed
        scaler /= (int32_t)effect->fadeTime;
        scaler += effect->fadeLevel;
    }
    scaler = signbit(effect->magnitude) ? -scaler : scaler; // Follow original sign of magnitude because envelope has no sign (important for constant force)
    return scaler;
}
 
void EffectsCalculator::setFilters(FFB_Effect *effect){
 
    std::function<void(std::unique_ptr<Biquad> &)> fnptr = [=](std::unique_ptr<Biquad> &filter){};
 
    switch (effect->type)
    {
    case FFB_EFFECT_DAMPER:
        fnptr = [=, this](std::unique_ptr<Biquad> &filter){
            if (filter != nullptr)
                filter->setBiquad(BiquadType::lowpass, this->filter[filterProfileId].damper.freq/ (float)calcfrequency, this->filter[filterProfileId].damper.q * qfloatScaler , (float)0.0);
            else
                filter = std::make_unique<Biquad>(BiquadType::lowpass, this->filter[filterProfileId].damper.freq / (float)calcfrequency, this->filter[filterProfileId].damper.q * qfloatScaler, (float)0.0);
        };
        break;
    case FFB_EFFECT_FRICTION:
        fnptr = [=, this](std::unique_ptr<Biquad> &filter){
            if (filter != nullptr)
                filter->setBiquad(BiquadType::lowpass, this->filter[filterProfileId].friction.freq / (float)calcfrequency, this->filter[filterProfileId].friction.q * qfloatScaler, (float)0.0);
            else
                filter = std::make_unique<Biquad>(BiquadType::lowpass, this->filter[filterProfileId].friction.freq / (float)calcfrequency, this->filter[filterProfileId].friction.q * qfloatScaler, (float)0.0);
        };
        break;
    case FFB_EFFECT_INERTIA:
        fnptr = [=, this](std::unique_ptr<Biquad> &filter){
            if (filter != nullptr)
                filter->setBiquad(BiquadType::lowpass, this->filter[filterProfileId].inertia.freq / (float)calcfrequency, this->filter[filterProfileId].inertia.q * qfloatScaler, (float)0.0);
            else
                filter = std::make_unique<Biquad>(BiquadType::lowpass, this->filter[filterProfileId].inertia.freq / (float)calcfrequency, this->filter[filterProfileId].inertia.q * qfloatScaler, (float)0.0);
        };
        break;
    case FFB_EFFECT_CONSTANT:
        fnptr = [=, this](std::unique_ptr<Biquad> &filter){
            if (filter != nullptr)
                filter->setBiquad(BiquadType::lowpass, this->filter[0].constant.freq / (float)calcfrequency, this->filter[0].constant.q * qfloatScaler, (float)0.0);
            else
                filter = std::make_unique<Biquad>(BiquadType::lowpass, this->filter[0].constant.freq / (float)calcfrequency, this->filter[0].constant.q * qfloatScaler, (float)0.0);
        };
        break;
    }
 
 
    for (int i=0; i<MAX_AXIS; i++) {
        fnptr(effect->filter[i]);
    }
}
 
 
void EffectsCalculator::setGain(uint8_t gain)
{
    global_gain = gain;
}
 
uint8_t EffectsCalculator::getGain() { return global_gain; }
 
 
 
/*
 * Read parameters from flash and restore settings
 */
void EffectsCalculator::restoreFlash()
{
    uint16_t filterStorage;
    if (Flash_Read(ADR_FFB_CF_FILTER, &filterStorage))
    {
        uint32_t freq = filterStorage & 0x1FF;
        uint8_t q = (filterStorage >> 9) & 0x7F;
        checkFilterCoeff(&(this->filter[0].constant), freq, q);
        updateFilterSettingsForEffects(FFB_EFFECT_CONSTANT);
    }
 
    if (Flash_Read(ADR_FFB_FR_FILTER, &filterStorage))
    {
        uint32_t freq = filterStorage & 0x1FF;
        uint8_t q = (filterStorage >> 9) & 0x7F;
        checkFilterCoeff(&(this->filter[CUSTOM_PROFILE_ID].friction), freq, q);
        updateFilterSettingsForEffects(FFB_EFFECT_FRICTION);
    }
 
    if (Flash_Read(ADR_FFB_DA_FILTER, &filterStorage))
    {
        uint32_t freq = filterStorage & 0x1FF;
        uint8_t q = (filterStorage >> 9) & 0x7F;
        checkFilterCoeff(&(this->filter[CUSTOM_PROFILE_ID].damper), freq, q);
        updateFilterSettingsForEffects(FFB_EFFECT_DAMPER);
    }
 
    if (Flash_Read(ADR_FFB_IN_FILTER, &filterStorage))
    {
        uint32_t freq = filterStorage & 0x1FF;
        uint8_t q = (filterStorage >> 9) & 0x7F;
        checkFilterCoeff(&(this->filter[CUSTOM_PROFILE_ID].inertia), freq, q);
        updateFilterSettingsForEffects(FFB_EFFECT_INERTIA);
    }
 
    uint16_t effects = 0;
    if(Flash_Read(ADR_FFB_EFFECTS1, &effects)){
        gain.friction = (effects >> 8) & 0xff;
        gain.inertia = (effects & 0xff);
    }
    if(Flash_Read(ADR_FFB_EFFECTS2, &effects)){
        gain.damper = (effects >> 8) & 0xff;
        gain.spring = (effects & 0xff);
    }
    if(Flash_Read(ADR_FFB_EFFECTS3, &effects)){
        filterProfileId = (effects >> 8) & 0x03;
        frictionPctSpeedToRampup = (effects & 0xff);
    }
 
}
 
// Saves parameters to flash
void EffectsCalculator::saveFlash()
{
    uint16_t filterStorage;
 
    // save CF biquad
    filterStorage = (uint16_t)filter[0].constant.freq & 0x1FF;
    filterStorage |= ( (uint16_t)filter[0].constant.q & 0x7F ) << 9 ;
    Flash_Write(ADR_FFB_CF_FILTER, filterStorage);
 
    if(filterProfileId == CUSTOM_PROFILE_ID){ // Only attempt saving if custom profile active
        // save Friction biquad
        filterStorage = (uint16_t)filter[CUSTOM_PROFILE_ID].friction.freq & 0x1FF;
        filterStorage |= ( (uint16_t)filter[CUSTOM_PROFILE_ID].friction.q & 0x7F ) << 9 ;
        Flash_Write(ADR_FFB_FR_FILTER, filterStorage);
 
        // save Damper biquad
        filterStorage = (uint16_t)filter[CUSTOM_PROFILE_ID].damper.freq & 0x1FF;
        filterStorage |= ( (uint16_t)filter[CUSTOM_PROFILE_ID].damper.q & 0x7F ) << 9 ;
        Flash_Write(ADR_FFB_DA_FILTER, filterStorage);
 
        // save Inertia biquad
        filterStorage = (uint16_t)filter[CUSTOM_PROFILE_ID].inertia.freq & 0x1FF;
        filterStorage |= ( (uint16_t)filter[CUSTOM_PROFILE_ID].inertia.q & 0x7F ) << 9 ;
        Flash_Write(ADR_FFB_IN_FILTER, filterStorage);
    }
 
    // save the effect gain
    uint16_t effects = gain.inertia | (gain.friction << 8);
    Flash_Write(ADR_FFB_EFFECTS1, effects);
 
    effects = gain.spring | (gain.damper << 8);
    Flash_Write(ADR_FFB_EFFECTS2, effects);
 
    // save the friction rampup zone
    effects = frictionPctSpeedToRampup | (filterProfileId << 8);
    Flash_Write(ADR_FFB_EFFECTS3, effects);
 
}
 
void EffectsCalculator::checkFilterCoeff(biquad_constant_t *filter, uint32_t freq,uint8_t q)
{
    if(q == 0) {
        q = 1;
    }
 
    if(freq == 0){
        freq = calcfrequency / 2;
    }
 
    filter->freq = clip<uint32_t, uint32_t>(freq, 1, (calcfrequency / 2));
    filter->q = clip<uint8_t, uint8_t>(q,0,127);
}
 
void EffectsCalculator::updateFilterSettingsForEffects(uint8_t type_effect) {
 
    // loop on all effect in memory and setup new constant filter
    for (uint8_t i = 0; i < MAX_EFFECTS; i++)
    {
        if (effects[i].type == type_effect)
        {
            setFilters(&effects[i]);
        }
    }
}
 
 
void EffectsCalculator::logEffectType(uint8_t type,bool remove){
    if(type > 0 && type < 32){
 
        if(remove){
            if(effects_stats[type-1].nb > 0)
                effects_stats[type-1].nb--;
 
            if(!effects_stats[type-1].nb){
                //effects_used &= ~(1<<(type-1)); // Only manual reset
                //effects_stats[type-1].max = 0;
                effects_stats[type-1].current = {0};
            }
        }else{
            effects_used |= 1<<(type-1);
            if( effects_stats[type-1].nb < 65535 ) {
                effects_stats[type-1].nb ++;
            }
        }
    }
}
 
void EffectsCalculator::logEffectState(uint8_t type,uint8_t state){
    if(type > 0 && type < 32){
        if(!state){
            // effects_stats[type-1].max = 0;
            effects_stats[type-1].current = {0};
        }
    }
}
 
 
void EffectsCalculator::calcStatsEffectType(uint8_t type, int16_t force,uint8_t axis){
    if(axis >= MAX_AXIS)
        return;
    if(type > 0 && type < 13) {
        uint8_t arrayLocation = type - 1;
        effects_stats[arrayLocation].current[axis] = clip<int32_t,int16_t>(effects_stats[arrayLocation].current[axis] + force, -0x7fff, 0x7fff);
        effects_stats[arrayLocation].max[axis] = std::max(effects_stats[arrayLocation].max[axis], (int16_t)abs(force));
    }
}
 
std::string EffectsCalculator::listEffectsUsed(bool details,uint8_t axis){
    std::string effects_list = "";
    if(axis >= MAX_AXIS)
        return "";
 
    if (!details) {
        if(effects_used == 0){
            return "None";
        }
 
        static const char *effects[12] = {"Constant,","Ramp,","Square,","Sine,","Triangle,","Sawtooth Up,","Sawtooth Down,","Spring,","Damper,","Inertia,","Friction,","Custom,"};
 
        for (int i=0;i < 12; i++) {
            if((effects_used >> i) & 1) {
                effects_list += effects[i];
            }
        }
 
        effects_list.pop_back();
    } else {
 
        bool firstItem = true;
        for (int i=0;i < 12; i++) {
            if (!firstItem) effects_list += ", ";
            effects_list += "{\"max\":" + std::to_string(effects_stats[i].max[axis]);
            effects_list += ", \"curr\":" + std::to_string(effects_stats[i].current[axis]);
            effects_list += ", \"nb\":" + std::to_string(effects_stats[i].nb) + "}";
            firstItem = false;
        }
 
    }
 
    return effects_list.c_str();
}
 
void EffectsCalculator::resetLoggedActiveEffects(bool reinit){
    effects_used = 0;
    if(reinit){
        for (int i=0;i < 12; i++) {
            if(effects_stats[i].nb > 0) {
                effects_used |= 1<<(i);
            }
        }
    }
}
 
CommandStatus EffectsCalculator::command(const ParsedCommand& cmd,std::vector<CommandReply>& replies){
    switch(static_cast<EffectsCalculator_commands>(cmd.cmdId)){
 
    case EffectsCalculator_commands::ffbfiltercf:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[0].constant.freq);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[0].constant, cmd.val, filter[0].constant.q);
            updateFilterSettingsForEffects(FFB_EFFECT_CONSTANT);
        }
        break;
    case EffectsCalculator_commands::ffbfiltercf_q:
        if(cmd.type == CMDtype::info){
            replies.emplace_back("scale:"+std::to_string(this->qfloatScaler));
        }
        else if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[0].constant.q);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[0].constant, filter[0].constant.freq, cmd.val);
            updateFilterSettingsForEffects(FFB_EFFECT_CONSTANT);
        }
        break;
    case EffectsCalculator_commands::effects:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(effects_used); //listEffectsUsed(cmd.val)
        }
        else if (cmd.type == CMDtype::set)
        {
            resetLoggedActiveEffects(cmd.val == 0);
        }
        else if (cmd.type == CMDtype::info)
        {
            replies.emplace_back(listEffectsUsed(false));
        }
        break;
    case EffectsCalculator_commands::effectsDetails:
        if (cmd.type == CMDtype::get || cmd.type == CMDtype::getat)
        {
            replies.emplace_back(listEffectsUsed(true,cmd.adr));
        }
        else if (cmd.type == CMDtype::set && cmd.val >= 0)
        {
            for (int i=0; i<12; i++) {
                effects_stats[i].max = {0};
                if(cmd.val > 0){
                    effects_stats[i].current = {0};
                    effects_stats[i].nb = 0;
                }
            }
            resetLoggedActiveEffects(true);
        }
        break;
    case EffectsCalculator_commands::effectsForces:
    {
        uint8_t axis = 0;
        if(cmd.type == CMDtype::getat){
            axis = std::min<uint8_t>(cmd.adr,MAX_AXIS);
        }
        if (cmd.type == CMDtype::get || cmd.type == CMDtype::getat)
        {
            for (size_t i=0; i < effects_statslast.size(); i++) {
                replies.emplace_back(effects_statslast[i].current[axis],effects_statslast[i].nb);
            }
        }
        break;
    }
    case EffectsCalculator_commands::spring:
        if(cmd.type == CMDtype::info){
            replies.emplace_back("scale:"+std::to_string(this->scaler.spring));
        }else
            return handleGetSet(cmd, replies, this->gain.spring);
        break;
    case EffectsCalculator_commands::friction:
        if(cmd.type == CMDtype::info){
            replies.emplace_back("scale:"+std::to_string(this->scaler.friction)+",factor:"+std::to_string(INTERNAL_SCALER_FRICTION));
        }else
            return handleGetSet(cmd, replies, this->gain.friction);
        break;
    case EffectsCalculator_commands::damper:
        if(cmd.type == CMDtype::info){
            replies.emplace_back("scale:"+std::to_string(this->scaler.damper)+",factor:"+std::to_string(INTERNAL_SCALER_DAMPER));
        }else
            return handleGetSet(cmd, replies, this->gain.damper);
        break;
    case EffectsCalculator_commands::inertia:
        if(cmd.type == CMDtype::info){
            replies.emplace_back("scale:"+std::to_string(this->scaler.inertia)+",factor:"+std::to_string(INTERNAL_SCALER_INERTIA));
        }else
            return handleGetSet(cmd, replies, this->gain.inertia);
        break;
    case EffectsCalculator_commands::damper_f:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[filterProfileId].damper.freq);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[CUSTOM_PROFILE_ID].damper, cmd.val, filter[CUSTOM_PROFILE_ID].damper.q);
            if (filterProfileId == CUSTOM_PROFILE_ID) updateFilterSettingsForEffects(FFB_EFFECT_DAMPER);
        }
        break;
    case EffectsCalculator_commands::damper_q:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[filterProfileId].damper.q);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[CUSTOM_PROFILE_ID].damper, filter[CUSTOM_PROFILE_ID].damper.freq, cmd.val);
            if (filterProfileId == CUSTOM_PROFILE_ID) updateFilterSettingsForEffects(FFB_EFFECT_DAMPER);
        }
        break;
    case EffectsCalculator_commands::friction_f:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[filterProfileId].friction.freq);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[CUSTOM_PROFILE_ID].friction, cmd.val, filter[CUSTOM_PROFILE_ID].friction.q);
            if (filterProfileId == CUSTOM_PROFILE_ID) updateFilterSettingsForEffects(FFB_EFFECT_FRICTION);
        }
        break;
    case EffectsCalculator_commands::friction_q:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[filterProfileId].friction.q);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[CUSTOM_PROFILE_ID].friction, filter[CUSTOM_PROFILE_ID].friction.freq, cmd.val);
            if (filterProfileId == CUSTOM_PROFILE_ID) updateFilterSettingsForEffects(FFB_EFFECT_FRICTION);
        }
        break;
    case EffectsCalculator_commands::inertia_f:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[filterProfileId].inertia.freq);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[CUSTOM_PROFILE_ID].inertia, cmd.val, filter[CUSTOM_PROFILE_ID].inertia.q);
            if (filterProfileId == CUSTOM_PROFILE_ID) updateFilterSettingsForEffects(FFB_EFFECT_INERTIA);
        }
        break;
    case EffectsCalculator_commands::inertia_q:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(filter[filterProfileId].inertia.q);
        }
        else if (cmd.type == CMDtype::set)
        {
            checkFilterCoeff(&filter[CUSTOM_PROFILE_ID].inertia, filter[CUSTOM_PROFILE_ID].inertia.freq, cmd.val);
            if (filterProfileId == CUSTOM_PROFILE_ID) updateFilterSettingsForEffects(FFB_EFFECT_INERTIA);
        }
        break;
 
    case EffectsCalculator_commands::frictionPctSpeedToRampup:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(frictionPctSpeedToRampup);
        }
        else if (cmd.type == CMDtype::set)
        {
            uint8_t pct = clip<uint8_t, uint8_t>(cmd.val, 0, 100);
            frictionPctSpeedToRampup = pct;
        }
        break;
    case EffectsCalculator_commands::filterProfileId:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(this->filterProfileId);
        }
        else if (cmd.type == CMDtype::set)
        {
            uint32_t value = clip<uint32_t, uint32_t>(cmd.val, 0, 1);
            this->filterProfileId = value;
            updateFilterSettingsForEffects(FFB_EFFECT_INERTIA);
            updateFilterSettingsForEffects(FFB_EFFECT_DAMPER);
            updateFilterSettingsForEffects(FFB_EFFECT_FRICTION);
        }
        break;
    case EffectsCalculator_commands::monitorEffect:
        if (cmd.type == CMDtype::get)
        {
            replies.emplace_back(isMonitorEffect);
        }
        else if (cmd.type == CMDtype::set)
        {
            isMonitorEffect = clip<uint8_t, uint8_t>(cmd.val, 0, 1);
        }
        break;
 
    default:
        return CommandStatus::NOT_FOUND;
    }
    return CommandStatus::OK;
}
 
/*
 *
 */
void EffectsCalculator::Run() {
    std::vector<CommandReply> replies;
    Delay(500);
    while (true) {
        Delay(3000);
 
        if(isMonitorEffect) {
 
            continue; // TODO uncomment when stream is ok
            replies.push_back(CommandReply(listEffectsUsed(true)));
            CommandInterface::broadcastCommandReplyAsync(replies,
                    this,
                    (uint32_t)EffectsCalculator_commands::effectsDetails,
                    CMDtype::get);
 
        }
 
    }
 
}
 
void EffectsCalculator::free_effect(uint16_t idx){
    if(idx < this->effects.size()){
        logEffectType(effects[idx].type, true); // Effect off
        effects[idx] = FFB_Effect(); // Reset all settings
        for(int i=0; i< MAX_AXIS; i++) {
            if(effects[idx].filter[i] != nullptr){
                effects[idx].filter[i].reset(nullptr);
            }
        }
    }
}
 
int32_t EffectsCalculator::find_free_effect(uint8_t type){
    if(type > FFB_EFFECT_NONE && type < FFB_EFFECT_CUSTOM+1){ // Check if it is a valid effect type
        for(uint8_t i=0;i<effects.size();i++){
            if(effects[i].type == FFB_EFFECT_NONE){
                return(i);
            }
        }
    }
    return -1;
}
 
 
 
 
uint32_t EffectsControlItf::getRate(){
    float periodAvg = fxPeriodAvg.getAverage();
    if((HAL_GetTick() - lastFxUpdate) > 1000 || periodAvg == 0){
        // Reset average
        fxPeriodAvg.clear();
        return 0;
    }else{
        return (1000.0/periodAvg);
    }
}
 
uint32_t EffectsControlItf::getConstantForceRate(){
    float periodAvg = cfUpdatePeriodAvg.getAverage();
    if((HAL_GetTick() - lastCfUpdate) > 1000 || periodAvg == 0){
        // Reset average
        cfUpdatePeriodAvg.clear();
        return 0;
    }else{
        return (1000.0/periodAvg);
    }
}
 
 
void EffectsControlItf::cfUpdateEvent(){
    cfUpdatePeriodAvg.addValue((uint32_t)(HAL_GetTick() - lastCfUpdate));
    lastCfUpdate = HAL_GetTick();
}
 
void EffectsControlItf::fxUpdateEvent(){
    fxPeriodAvg.addValue((uint32_t)(HAL_GetTick() - lastFxUpdate));
    lastFxUpdate = HAL_GetTick();
}