Documentation
Keywords: documentation tutorials
This is the main documentation page for liquid-dsp .
Background and History∞
Tutorials∞
Here are some basic tutorials for getting started coding with liquid:
- tutorial-fec - This tutorial describes basic forward error-correction coding using liquid.
- tutorial-pll - This tutorial explains how to create and simulate a basic phase-locked loop in liquid. I have also written a few blog posts on this subject.
- tutorial-framing - This tutorial introduces a very simple framing structure that allows you to easily send and receive data over a wireless link.
- tutorial-ofdmflexframe - This tutorial extends the basic framing tutorial by introducing the flexible OFDM framing structure.
Modules and Objects∞
- autocorr - auto-correlation object
- agc - automatic gain control
- ampmodem - analog amplitude modulation (AM) and demodulation
- asgram - ASCII spectral periodogram
- bpacket - binary packet generator and synchronizer objects
- bsequence - binary sequence generator
- cbuffer - circular buffering
- ccodes - complementary codes
- channel - channel emulation
- cpfskmodem - continuous phase frequency-shift keying modulation
- crc - cyclic redundancy check (and checksum) for verifying data integrity
- cvsd - continuously-variable slope delta audio encoder
- dds - direct digital synthesis
- dotprod - vector dot product
- equalization - least mean-squares (LMS) and recursive least-squares (RLS) equalization
- experimental - experimental builds
- fec - forward error-correction coding
- fft - fast Fourier transforms
- fftfilt - FFT-based filter
- firdes - finite impulse-response (FIR) filter design
- firdecim - FIR decimation
- firfarrow - FIR Farrow filter structures
- firfilt - FIR filter operations
- firinterp - FIR interpolation
- firhilb - FIR Hilbert transforms
- firpfbch - FIR polyphase filterbank channelizer
- firpfbch2 - FIR polyphase filterbank channelizer (extended)
- flexframe - flexible framing structure
- frame64 - fixed-length (64-byte) framing strucutre
- freqmodem - analog frequency modulation (FM) and demodulation
- fskmodem - wide-band frequency-shift keying modem
- gasearch - genetic algorithm search optimization
- gmskmodem - Gauss minimum-shift keying (GMSK) modulation and demodulation
- gradsearch - gradient descent search optimization
- iirdecim - infinite impulse response (IIR) decimator
- iirinterp - infinite impulse response (IIR) interpolator
- iirdes - infinite impulse response (IIR) filter design
- iirfilt - IIR filter operations
- interleaver - data interleaver
- math - extended mathematical functions
- matrix - matrix algebra, linear solving, decomposition, etc.
- modem - linear digital modulation and demodulation
- msequence - maximum-length sequence generators (linear feedback shift registers)
- msource - multi-source signal generator for testing communications systems
- msresamp - multi-stage arbitrary resampler
- msresamp2 - multi-stage half-band resampler
- multichannel - multi-channel
- nco - numerically-controlled oscillator for mixing and tone generation
- ofdmflexframe - flexible framing structure for orthogonal frequency-divisional multiplexing (OFDM)
- ofdmframe - low-level OFDM framing and synchronization
- packetizer - simple data packet encoding and decoding
- polynomial - polynomial operations (root-finding algorithms, multiplication)
- qdetector - coarse detector with carrier and timing recovery
- qdsync - frame detector and synchronizer
- qnsearch - Quasi-Newton search
- quantization - sample quantization and compression
- qpacketmodem - combined modulation and forward error-correction
- qpilot - pilot symbol injection and synchronization for simple frames
- random - random number generators
- resamp2 - half-band resampling (interpolation and decimation)
- resamp - arbitrary irrational-rate resampler
- spgram - spectral periodogram
- symstream - simple symbol streaming generator
- symsync - digital modulation symbol timing synchronizer
- symtrack - symbol timing and carrier recovery for stream of symbols
- utility - useful utilities
- vector - low-level vector operations
- window - window buffering
- windowing - spectral windowing functions
- wdelay - window delay buffering