Application Program Interfaces

This is the main API definition page for liquid-dsp . Refer to the main documentation page for detailed algorithm descriptions.

Interfaces

Here is a complete list of APIs for objects in liquid :

  • agc : Automatic gain control (agc) for level correction and signal detection, variants: agc_crcf, agc_rrrf
  • asgram : ASCII spectral periodogram for computing and displaying an estimate of a signal's power spectrum with ASCII characters, variants: asgramcf, asgramf
  • autocorr : Computes auto-correlation with a fixed lag on input signals, variants: autocorr_cccf, autocorr_rrrf
  • bsync : Binary P/N synchronizer, variants: bsync_cccf, bsync_crcf, bsync_rrrf
  • cbuffer : Circular buffer object for storing and retrieving samples in a first-in/first-out (FIFO) manner using a minimal amount of memory, variants: cbuffercf, cbufferf
  • channel : Channel emulation, variants: channel_cccf
  • dds : Direct digital (up/down) synthesizer object, variants: dds_cccf
  • dotprod : Vector dot product operation, variants: dotprod_cccf, dotprod_crcf, dotprod_rrrf
  • eqlms : Least mean-squares equalization object, variants: eqlms_cccf, eqlms_rrrf
  • eqrls : Recursive least mean-squares equalization object, variants: eqrls_cccf, eqrls_rrrf
  • fdelay : Finite impulse response (FIR) filter, variants: fdelay_crcf, fdelay_rrrf
  • fft : Fast Fourier Transform (FFT) and inverse (plan) object, variants: fft
  • fftfilt : Fast Fourier transform (FFT) finite impulse response filter, variants: fftfilt_cccf, fftfilt_crcf, fftfilt_rrrf
  • firdecim : Finite impulse response (FIR) decimator, variants: firdecim_cccf, firdecim_crcf, firdecim_rrrf
  • firfarrow : Finite impulse response (FIR) Farrow filter for timing delay, variants: firfarrow_crcf, firfarrow_rrrf
  • firfilt : Finite impulse response (FIR) filter, variants: firfilt_cccf, firfilt_crcf, firfilt_rrrf
  • firhilb : Finite impulse response (FIR) Hilbert transform, variants: firhilbf
  • firinterp : Finite impulse response (FIR) interpolator, variants: firinterp_cccf, firinterp_crcf, firinterp_rrrf
  • firpfb : Finite impulse response (FIR) polyphase filter bank (PFB), variants: firpfb_cccf, firpfb_crcf, firpfb_rrrf
  • firpfbch : Finite impulse response polyphase filterbank channelizer, variants: firpfbch_cccf, firpfbch_crcf
  • firpfbch2 : Finite impulse response polyphase filterbank channelizer with output rate oversampled by a factor of 2, variants: firpfbch2_crcf
  • firpfbchr : Finite impulse response polyphase filterbank channelizer with output rational output rate \( P / M \), variants: firpfbchr_crcf
  • freqdem : Analog frequency demodulator, variants: freqdem
  • freqmod : Analog frequency modulation object, variants: freqmod
  • iirdecim : Infinite impulse response (IIR) decimator, variants: iirdecim_cccf, iirdecim_crcf, iirdecim_rrrf
  • iirfilt : Infinite impulse response (IIR) filter, variants: iirfilt_cccf, iirfilt_crcf, iirfilt_rrrf
  • iirfiltsos : Infinite impulse response filter primitive using second-order sections, variants: iirfiltsos_cccf, iirfiltsos_crcf, iirfiltsos_rrrf
  • iirhilb : Infinite impulse response (IIR) Hilbert transform, variants: iirhilbf
  • iirinterp : Infinite impulse response (IIR) interpolator, variants: iirinterp_cccf, iirinterp_crcf, iirinterp_rrrf
  • matrix : None, variants: matrix, matrixc, matrixcf, matrixf
  • modem : Linear modulator/demodulator (modem) object FIXME: need to point both modem and modemcf pointers to same struct typedef struct MODEM(_s) * MODEM();, variants: modem, modemcf
  • msource : Multi-signal source generator object, variants: msourcecf
  • msresamp : Multi-stage half-band resampler, implemented as cascaded dyadic (half-band) polyphase filter banks followed by an arbitrary rate resampler for interpolation and decimation., variants: msresamp_cccf, msresamp_crcf, msresamp_rrrf
  • msresamp2 : Multi-stage half-band resampler, implemented as cascaded dyadic (half-band) polyphase filter banks for interpolation and decimation., variants: msresamp2_cccf, msresamp2_crcf, msresamp2_rrrf
  • nco : Numerically-controlled oscillator object, variants: nco_crcf
  • ordfilt : Finite impulse response (FIR) filter, variants: ordfilt_rrrf
  • poly : None, variants: poly, polyc, polycf, polyf
  • presync : Pre-demodulation signal synchronizer, variants: bpresync_cccf, presync_cccf
  • qdetector : Frame detector and synchronizer; uses a novel correlation method to detect a synchronization pattern, estimate carrier frequency and phase offsets as well as timing phase, then correct for these impairments in a simple interface suitable for custom frame recovery., variants: qdetector_cccf
  • qdsync : Frame detector and synchronizer; uses a novel correlation method to detect a synchronization pattern, estimate carrier frequency and phase offsets as well as timing phase, then correct for these impairments in a simple interface suitable for custom frame recovery., variants: qdsync_cccf
  • qpacketmodem : Packet encoder/decoder, variants: qpacketmodem
  • quantizer : Amplitude quantization object, variants: quantizercf, quantizerf
  • resamp : Arbitrary rate resampler, implemented as a polyphase filterbank, variants: resamp_cccf, resamp_crcf, resamp_rrrf
  • resamp2 : Half-band resampler, implemented as a dyadic (half-band) polyphase filter bank for interpolation, decimation, synthesis, and analysis., variants: resamp2_cccf, resamp2_crcf, resamp2_rrrf
  • rresamp : Rational rate resampler, implemented as a polyphase filterbank, variants: rresamp_cccf, rresamp_crcf, rresamp_rrrf
  • smatrix : Sparse matrix object (similar to MacKay, Davey, Lafferty convention), variants: smatrixb, smatrixf, smatrixi
  • spgram : Spectral periodogram object for computing power spectral density estimates of various signals, variants: spgramcf, spgramf
  • spwaterfall : Spectral periodogram waterfall object for computing time-varying power spectral density estimates, variants: spwaterfallcf, spwaterfallf
  • symstream : Symbol streaming generator object, variants: symstreamcf
  • symstreamr : Symbol streaming generator object, variants: symstreamrcf
  • symsync : Multi-rate symbol synchronizer for symbol timing recovery., variants: symsync_crcf, symsync_rrrf
  • symtrack : Symbol synchronizer and tracking object, variants: symtrack_cccf, symtrack_rrrf
  • synth : Numerically-controlled synthesizer (direct digital synthesis) with internal phase-locked loop (pll) implementation, variants:
  • tvmpch : Time-varying multipath channel emulation, variants: tvmpch_cccf
  • vector : None, variants: liquid_vectorcf, liquid_vectorf
  • wdelay : Efficient digital delay line using a minimal amount of memory, variants: wdelaycf, wdelayf
  • window : Sliding window first-in/first-out buffer with a fixed size, variants: windowcf, windowf