Getting Started

Installing tools

libquiet requires Cmake for its builds.

Installing Dependencies

  • Install libcorrect

  • Install liquid dsp. The devel branch must be installed.

  • Install libjansson

  • (Optional) Install PortAudio which allows Quiet to interface with your soundcard. This is highly recommended.

  • (Optional) Install libsndfile which allows Quiet to read and write .wav files containing encoded sounds.

Installing libquiet

After installing all dependencies, clone libquiet, cd to directory where it is cloned, then run

mkdir build

cd build

cmake ..

make

make install

Headers

To access libquiet's API,

#include <quiet.h>

If you have installed PortAudio and have installed libquiet's PortAudio wrapper, you can access the PortAudio-backed transmitter and receiver with

#include <quiet-portaudio.h>

Linking

Make sure that libquiet.so or libquiet.dylib is in your LDPATH.

For static linking, you'll want to link against libquiet, libjansson, libliquid and libfec.