wdsp/cfcomp.c

/*	cfcomp.c

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

Copyright (C) 2017, 2021 Warren Pratt, NR0V

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

*/

#include "comm.h"

void calc_cfcwindow (CFCOMP a)
{
	int i;
	double arg0, arg1, cgsum, igsum, coherent_gain, inherent_power_gain, wmult;
	switch (a->wintype)
	{
	case 0:
		arg0 = 2.0 * PI / (double)a->fsize;
		cgsum = 0.0;
		igsum = 0.0;
		for (i = 0; i < a->fsize; i++)
		{
			a->window[i] = sqrt (0.54 - 0.46 * cos((double)i * arg0));
			cgsum += a->window[i];
			igsum += a->window[i] * a->window[i];
		}
		coherent_gain = cgsum / (double)a->fsize;
		inherent_power_gain = igsum / (double)a->fsize;
		wmult = 1.0 / sqrt (inherent_power_gain);
		for (i = 0; i < a->fsize; i++)
			a->window[i] *= wmult;
		a->winfudge = sqrt (1.0 / coherent_gain);
		break;
	case 1:
		arg0 = 2.0 * PI / (double)a->fsize;
		cgsum = 0.0;
		igsum = 0.0;
		for (i = 0; i < a->fsize; i++)
		{
			arg1 = cos(arg0 * (double)i);
			a->window[i]  = sqrt   (+0.21747
						  + arg1 * (-0.45325
						  + arg1 * (+0.28256
						  + arg1 * (-0.04672))));
			cgsum += a->window[i];
			igsum += a->window[i] * a->window[i];
		}
		coherent_gain = cgsum / (double)a->fsize;
		inherent_power_gain = igsum / (double)a->fsize;
		wmult = 1.0 / sqrt (inherent_power_gain);
		for (i = 0; i < a->fsize; i++)
			a->window[i] *= wmult;
		a->winfudge = sqrt (1.0 / coherent_gain);
		break;
	}
}

int fCOMPcompare (const void * a, const void * b)
{
	if (*(double*)a < *(double*)b)
		return -1;
	else if (*(double*)a == *(double*)b)
		return 0;
	else
		return 1;
}

void calc_comp (CFCOMP a)
{
	int i, j;
	double f, frac, fincr, fmax;
	double* sary;
	a->precomplin = pow (10.0, 0.05 * a->precomp);
	a->prepeqlin  = pow (10.0, 0.05 * a->prepeq);
	fmax = 0.5 * a->rate;
	for (i = 0; i < a->nfreqs; i++)
	{
		a->F[i] = max (a->F[i], 0.0);
		a->F[i] = min (a->F[i], fmax);
		a->G[i] = max (a->G[i], 0.0);
	}
	sary = (double *)malloc0 (3 * a->nfreqs * sizeof (double));
	for (i = 0; i < a->nfreqs; i++)
	{
		sary[3 * i + 0] = a->F[i];
		sary[3 * i + 1] = a->G[i];
		sary[3 * i + 2] = a->E[i];
	}
	qsort (sary, a->nfreqs, 3 * sizeof (double), fCOMPcompare);
	for (i = 0; i < a->nfreqs; i++)
	{
		a->F[i] = sary[3 * i + 0];
		a->G[i] = sary[3 * i + 1];
		a->E[i] = sary[3 * i + 2];
	}
	_aligned_free (sary);
	a->fp[0] = 0.0;
	a->fp[a->nfreqs + 1] = fmax;
	a->gp[0] = a->G[0];
	a->gp[a->nfreqs + 1] = a->G[a->nfreqs - 1];
	a->ep[0] = a->E[0];								// cutoff?
	a->ep[a->nfreqs + 1] = a->E[a->nfreqs - 1];		// cutoff?
	for (i = 0, j = 1; i < a->nfreqs; i++, j++)
	{
		a->fp[j] = a->F[i];
		a->gp[j] = a->G[i];
		a->ep[j] = a->E[i];
	}
	fincr = a->rate / (double)a->fsize;
	j = 0;
	// print_impulse ("gp.txt", a->nfreqs+2, a->gp, 0, 0);
	for (i = 0; i < a->msize; i++)
	{
		f = fincr * (double)i;
		while (f >= a->fp[j + 1] && j < a->nfreqs) j++;
		frac = (f - a->fp[j]) / (a->fp[j + 1] - a->fp[j]);
		a->comp[i] = pow (10.0, 0.05 * (frac * a->gp[j + 1] + (1.0 - frac) * a->gp[j]));
		a->peq[i]  = pow (10.0, 0.05 * (frac * a->ep[j + 1] + (1.0 - frac) * a->ep[j]));
		a->cfc_gain[i] = a->precomplin * a->comp[i];
	}
	// print_impulse ("comp.txt", a->msize, a->comp, 0, 0);
}

void calc_cfcomp(CFCOMP a)
{
	int i;
	a->incr = a->fsize / a->ovrlp;
	if (a->fsize > a->bsize)
		a->iasize = a->fsize;
	else
		a->iasize = a->bsize + a->fsize - a->incr;
	a->iainidx = 0;
	a->iaoutidx = 0;
	if (a->fsize > a->bsize)
	{
		if (a->bsize > a->incr)	 a->oasize = a->bsize;
		else					 a->oasize = a->incr;
		a->oainidx = (a->fsize - a->bsize - a->incr) % a->oasize;
	}
	else
	{
		a->oasize = a->bsize;
		a->oainidx = a->fsize - a->incr;
	}
	a->init_oainidx = a->oainidx;
	a->oaoutidx = 0;
	a->msize = a->fsize / 2 + 1;
	a->window	 = (double *)malloc0 (a->fsize	* sizeof(double));
	a->inaccum	 = (double *)malloc0 (a->iasize * sizeof(double));
	a->forfftin	 = (double *)malloc0 (a->fsize	* sizeof(double));
	a->forfftout = (double *)malloc0 (a->msize	* sizeof(complex));
	a->cmask	 = (double *)malloc0 (a->msize	* sizeof(double));
	a->mask		 = (double *)malloc0 (a->msize	* sizeof(double));
	a->cfc_gain	 = (double *)malloc0 (a->msize	* sizeof(double));
	a->revfftin	 = (double *)malloc0 (a->msize	* sizeof(complex));
	a->revfftout = (double *)malloc0 (a->fsize	* sizeof(double));
	a->save		 = (double **)malloc0(a->ovrlp	* sizeof(double *));
	for (i = 0; i < a->ovrlp; i++)
		a->save[i] = (double *)malloc0(a->fsize * sizeof(double));
	a->outaccum = (double *)malloc0(a->oasize * sizeof(double));
	a->nsamps = 0;
	a->saveidx = 0;
	a->Rfor = fftw_plan_dft_r2c_1d(a->fsize, a->forfftin, (fftw_complex *)a->forfftout, FFTW_ESTIMATE);
	a->Rrev = fftw_plan_dft_c2r_1d(a->fsize, (fftw_complex *)a->revfftin, a->revfftout, FFTW_ESTIMATE);
	calc_cfcwindow(a);

	a->pregain	= (2.0 * a->winfudge) / (double)a->fsize;
	a->postgain = 0.5 / ((double)a->ovrlp * a->winfudge);

	a->fp = (double *) malloc0 ((a->nfreqs + 2) * sizeof (double));
	a->gp = (double *) malloc0 ((a->nfreqs + 2) * sizeof (double));
	a->ep = (double *) malloc0 ((a->nfreqs + 2) * sizeof (double));
	a->comp = (double *) malloc0 (a->msize * sizeof (double));
	a->peq	= (double *) malloc0 (a->msize * sizeof (double));
	calc_comp (a);

	a->gain = 0.0;
	a->mmult = exp (-1.0 / (a->rate * a->ovrlp * a->mtau));
	a->dmult = exp (-(double)a->fsize / (a->rate * a->ovrlp * a->dtau));

	a->delta		 = (double*)malloc0 (a->msize * sizeof(double));
	a->delta_copy	 = (double*)malloc0 (a->msize * sizeof(double));
	a->cfc_gain_copy = (double*)malloc0 (a->msize * sizeof(double));
}

void decalc_cfcomp(CFCOMP a)
{
	int i;
	_aligned_free (a->cfc_gain_copy);
	_aligned_free (a->delta_copy);
	_aligned_free (a->delta);
	_aligned_free (a->peq);
	_aligned_free (a->comp);
	_aligned_free (a->ep);
	_aligned_free (a->gp);
	_aligned_free (a->fp);

	fftw_destroy_plan(a->Rrev);
	fftw_destroy_plan(a->Rfor);
	_aligned_free(a->outaccum);
	for (i = 0; i < a->ovrlp; i++)
		_aligned_free(a->save[i]);
	_aligned_free(a->save);
	_aligned_free(a->revfftout);
	_aligned_free(a->revfftin);
	_aligned_free(a->cfc_gain);
	_aligned_free(a->mask);
	_aligned_free(a->cmask);
	_aligned_free(a->forfftout);
	_aligned_free(a->forfftin);
	_aligned_free(a->inaccum);
	_aligned_free(a->window);
}

CFCOMP create_cfcomp (int run, int position, int peq_run, int size, double* in, double* out, int fsize, int ovrlp,
	int rate, int wintype, int comp_method, int nfreqs, double precomp, double prepeq, double* F, double* G, double* E, double mtau, double dtau)
{
	CFCOMP a = (CFCOMP) malloc0 (sizeof (cfcomp));
	
	a->run = run;
	a->position = position;
	a->peq_run = peq_run;
	a->bsize = size;
	a->in = in;
	a->out = out;
	a->fsize = fsize;
	a->ovrlp = ovrlp;
	a->rate = rate;
	a->wintype = wintype;
	a->comp_method = comp_method;
	a->nfreqs = nfreqs;
	a->precomp = precomp;
	a->prepeq = prepeq;
	a->mtau = mtau;					// compression metering time constant
	a->dtau = dtau;					// compression display time constant
	a->F = (double *)malloc0 (a->nfreqs * sizeof (double));
	a->G = (double *)malloc0 (a->nfreqs * sizeof (double));
	a->E = (double *)malloc0 (a->nfreqs * sizeof (double));
	memcpy (a->F, F, a->nfreqs * sizeof (double));
	memcpy (a->G, G, a->nfreqs * sizeof (double));
	memcpy (a->E, E, a->nfreqs * sizeof (double));
	calc_cfcomp (a);
	return a;
}

void flush_cfcomp (CFCOMP a)
{
	int i;
	memset (a->inaccum, 0, a->iasize * sizeof (double));
	for (i = 0; i < a->ovrlp; i++)
		memset (a->save[i], 0, a->fsize * sizeof (double));
	memset (a->outaccum, 0, a->oasize * sizeof (double));
	a->nsamps	= 0;
	a->iainidx	= 0;
	a->iaoutidx = 0;
	a->oainidx	= a->init_oainidx;
	a->oaoutidx = 0;
	a->saveidx	= 0;
	a->gain = 0.0;
	memset(a->delta, 0, a->msize * sizeof(double));
}

void destroy_cfcomp (CFCOMP a)
{
	decalc_cfcomp (a);
	_aligned_free (a->E);
	_aligned_free (a->G);
	_aligned_free (a->F);
	_aligned_free (a);
}


void calc_mask (CFCOMP a)
{
	int i;
	double comp, mask, delta;
	switch (a->comp_method)
	{
	case 0:
		{
			double mag, test;
			for (i = 0; i < a->msize; i++)
			{
				mag = sqrt (a->forfftout[2 * i + 0] * a->forfftout[2 * i + 0]
						  + a->forfftout[2 * i + 1] * a->forfftout[2 * i + 1]);
				comp = a->cfc_gain[i];
				test = comp * mag;
				if (test > 1.0)
					mask = 1.0 / mag;
				else
					mask = comp;
				a->cmask[i] = mask;
				if (test > a->gain) a->gain = test;
				else a->gain = a->mmult * a->gain;

				delta = a->cfc_gain[i] - a->cmask[i];
				if (delta > a->delta[i]) a->delta[i] = delta;
				else a->delta[i] *= a->dmult;
			}
			break;
		}
	}
	if (a->peq_run)
	{
		for (i = 0; i < a->msize; i++)
		{
			a->mask[i] = a->cmask[i] * a->prepeqlin * a->peq[i];
		}
	}
	else
		memcpy (a->mask, a->cmask, a->msize * sizeof (double));
	// print_impulse ("mask.txt", a->msize, a->mask, 0, 0);
	a->mask_ready = 1;
}

void xcfcomp (CFCOMP a, int pos)
{
	if (a->run && pos == a->position)
	{
		int i, j, k, sbuff, sbegin;
		/* Each ring index below steps by one and, since iasize >= fsize and
		   oasize >= incr always hold, wraps at most once per loop. The '% size'
		   per step was therefore an integer division for nothing -- about 5100
		   of them per call at fsize = 2048. Walk contiguous runs instead. */
		const int iasize = a->iasize;
		const int oasize = a->oasize;
		const int fsize = a->fsize;
		const int incr = a->incr;
		const int bsize = a->bsize;
		const int ovrlp = a->ovrlp;
		const double pregain = a->pregain;
		const double postgain = a->postgain;

		for (i = 0, j = a->iainidx; i < 2 * bsize; i += 2)
		{
			a->inaccum[j] = a->in[i];
			if (++j == iasize) j = 0;
		}
		a->iainidx = j;
		a->nsamps += bsize;
		while (a->nsamps >= fsize)
		{
			int n1 = iasize - a->iaoutidx;
			if (n1 > fsize) n1 = fsize;
			for (i = 0; i < n1; i++)
				a->forfftin[i] = pregain * a->window[i] * a->inaccum[a->iaoutidx + i];
			for (; i < fsize; i++)
				a->forfftin[i] = pregain * a->window[i] * a->inaccum[i - n1];
			if ((a->iaoutidx += incr) >= iasize) a->iaoutidx -= iasize;
			a->nsamps -= incr;
			fftw_execute (a->Rfor);
			calc_mask(a);
			for (i = 0; i < a->msize; i++)
			{
				a->revfftin[2 * i + 0] = a->mask[i] * a->forfftout[2 * i + 0];
				a->revfftin[2 * i + 1] = a->mask[i] * a->forfftout[2 * i + 1];
			}
			fftw_execute (a->Rrev);
			for (i = 0; i < fsize; i++)
				a->save[a->saveidx][i] = postgain * a->window[i] * a->revfftout[i];
			for (i = ovrlp; i > 0; i--)
			{
				const double* WDSP_RESTRICT sv;
				double* WDSP_RESTRICT oa = a->outaccum;
				int m1;
				sbuff = (a->saveidx + i) % ovrlp;
				sbegin = incr * (ovrlp - i);
				sv = a->save[sbuff] + sbegin;
				m1 = oasize - a->oainidx;
				if (m1 > incr) m1 = incr;
				k = a->oainidx;
				if (i == ovrlp)
				{
					for (j = 0; j < m1; j++)		oa[k + j] = sv[j];
					for (; j < incr; j++)			oa[j - m1] = sv[j];
				}
				else
				{
					for (j = 0; j < m1; j++)		oa[k + j] += sv[j];
					for (; j < incr; j++)			oa[j - m1] += sv[j];
				}
			}
			if (++a->saveidx == ovrlp) a->saveidx = 0;
			if ((a->oainidx += incr) >= oasize) a->oainidx -= oasize;
		}
		for (i = 0, k = a->oaoutidx; i < bsize; i++)
		{
			a->out[2 * i + 0] = a->outaccum[k];
			a->out[2 * i + 1] = 0.0;
			if (++k == oasize) k = 0;
		}
		a->oaoutidx = k;
	}
	else if (a->out != a->in)
		memcpy (a->out, a->in, a->bsize * sizeof (complex));
}

void setBuffers_cfcomp (CFCOMP a, double* in, double* out)
{
	a->in = in;
	a->out = out;
}

void setSamplerate_cfcomp (CFCOMP a, int rate)
{
	decalc_cfcomp (a);
	a->rate = rate;
	calc_cfcomp (a);
}

void setSize_cfcomp (CFCOMP a, int size)
{
	decalc_cfcomp (a);
	a->bsize = size;
	calc_cfcomp (a);
}

/********************************************************************************************************
*																										*
*											TXA Properties												*
*																										*
********************************************************************************************************/

PORT
void SetTXACFCOMPRun (int channel, int run)
{
	CFCOMP a = txa[channel].cfcomp.p;
	if (a->run != run)
	{
		EnterCriticalSection (&ch[channel].csDSP);
		a->run = run;
		LeaveCriticalSection (&ch[channel].csDSP);
	}
}

PORT
void SetTXACFCOMPPosition (int channel, int pos)
{
	CFCOMP a = txa[channel].cfcomp.p;
	if (a->position != pos)
	{
		EnterCriticalSection (&ch[channel].csDSP);
		a->position = pos;
		LeaveCriticalSection (&ch[channel].csDSP);
	}
}

PORT
void SetTXACFCOMPprofile (int channel, int nfreqs, double* F, double* G, double *E)
{
	CFCOMP a = txa[channel].cfcomp.p;
	EnterCriticalSection (&ch[channel].csDSP);
	a->nfreqs = nfreqs;
	_aligned_free (a->E);
	_aligned_free (a->F);
	_aligned_free (a->G);
	a->F = (double *)malloc0 (a->nfreqs * sizeof (double));
	a->G = (double *)malloc0 (a->nfreqs * sizeof (double));
	a->E = (double *)malloc0 (a->nfreqs * sizeof (double));
	memcpy (a->F, F, a->nfreqs * sizeof (double));
	memcpy (a->G, G, a->nfreqs * sizeof (double));
	memcpy (a->E, E, a->nfreqs * sizeof (double));
	_aligned_free (a->ep);
	_aligned_free (a->gp);
	_aligned_free (a->fp);
	a->fp = (double *) malloc0 ((a->nfreqs + 2) * sizeof (double));
	a->gp = (double *) malloc0 ((a->nfreqs + 2) * sizeof (double));
	a->ep = (double *) malloc0 ((a->nfreqs + 2) * sizeof (double));
	calc_comp(a);
	LeaveCriticalSection (&ch[channel].csDSP);
}

PORT
void SetTXACFCOMPPrecomp (int channel, double precomp)
{
	CFCOMP a = txa[channel].cfcomp.p;
	if (a->precomp != precomp)
	{
		EnterCriticalSection (&ch[channel].csDSP);
		a->precomp = precomp;
		a->precomplin = pow (10.0, 0.05 * a->precomp);
		for (int i = 0; i < a->msize; i++)
		{
			a->cfc_gain[i] = a->precomplin * a->comp[i];
		}
		LeaveCriticalSection (&ch[channel].csDSP);
	}
}

PORT
void SetTXACFCOMPPeqRun (int channel, int run)
{
	CFCOMP a = txa[channel].cfcomp.p;
	if (a->peq_run != run)
	{
		EnterCriticalSection (&ch[channel].csDSP);
		a->peq_run = run;
		LeaveCriticalSection (&ch[channel].csDSP);
	}
}

PORT
void SetTXACFCOMPPrePeq (int channel, double prepeq)
{
	CFCOMP a = txa[channel].cfcomp.p;
	EnterCriticalSection (&ch[channel].csDSP);
	a->prepeq = prepeq;
	a->prepeqlin = pow (10.0, 0.05 * a->prepeq);
	LeaveCriticalSection (&ch[channel].csDSP);
}

PORT
void GetTXACFCOMPDisplayCompression (int channel, double* comp_values, int* ready)
{
	int i;
	CFCOMP a = txa[channel].cfcomp.p;
	EnterCriticalSection(&ch[channel].csDSP);
	if (*ready = a->mask_ready)
	{
		memcpy(a->delta_copy, a->delta, a->msize * sizeof(double));
		memcpy(a->cfc_gain_copy, a->cfc_gain, a->msize * sizeof(double));
		a->mask_ready = 0;
	}
	LeaveCriticalSection(&ch[channel].csDSP);
	if (*ready)
	{
		for (i = 0; i < a->msize; i++)
			comp_values[i] = 20.0 * mlog10 (a->cfc_gain_copy[i] / (a->cfc_gain_copy[i] - a->delta_copy[i]));
	}
}