sdrangel/wdsp/osctrl.hpp

/*  osctrl.h

This file is part of a program that implements a Software-Defined Radio.

Copyright (C) 2014 Warren Pratt, NR0V
Copyright (C) 2024 Edouard Griffiths, F4EXB Adapted to SDRangel

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.

The author can be reached by email at

warren@wpratt.com

*/

// This file is part of the implementation of the Overshoot Controller from
// "Controlled Envelope Single Sideband" by David L. Hershberger, W9GR, in
// the November/December 2014 issue of QEX.

#ifndef wdsp_osctrl_h
#define wdsp_osctrl_h

#include "export.h"

namespace WDSP {

class TXA;

class WDSP_API OSCTRL
{
public:
    int run;                        // 1 to run; 0 otherwise
    int size;                       // buffer size
    float *inbuff;                 // input buffer
    float *outbuff;                // output buffer
    int rate;                       // sample rate
    float osgain;                  // gain applied to overshoot "clippings"
    float bw;                      // bandwidth
    int pn;                         // "peak stretcher" window, samples
    int dl_len;                     // delay line length, samples
    float* dl;                     // delay line for complex samples
    float* dlenv;                  // delay line for envelope values
    int in_idx;                     // input index for dl
    int out_idx;                    // output index for dl
    float max_env;                 // maximum env value in env delay line
    float env_out;

    static void xosctrl (OSCTRL *a);
    static OSCTRL* create_osctrl (
        int run,
        int size,
        float* inbuff,
        float* outbuff,
        int rate,
        float osgain
    );
    static void destroy_osctrl (OSCTRL *a);
    static void flush_osctrl (OSCTRL *a);
    static void setBuffers_osctrl (OSCTRL *a, float* in, float* out);
    static void setSamplerate_osctrl (OSCTRL *a, int rate);
    static void setSize_osctrl (OSCTRL *a, int size);
    // TXA Properties
    static void SetosctrlRun (TXA& txa, int run);

private:
    static void calc_osctrl (OSCTRL *a);
    static void decalc_osctrl (OSCTRL *a);
};

} // namespace WDSP

#endif