HiFiberry DSP
*************

Software for HiFiBerry boards equipped with DSP. This package can be 
used to read/write data to HiFiBerry DSP boards using the Beocreate TCP 
server.

Installation
============

Before installing the dsptoolkit, you need to have a working Python 3
installation (>=3.5) and a working pip. You also need to enable SPI as
dsptoolkit needs SPI to communicate with the DSP.
Check out 
https://www.raspberrypi-spy.co.uk/2014/08/enabling-the-spi-interface-on-the-raspberry-pi/

You can then install the toolkit by just running

 sudo pip3 install --upgrade hifiberrydsp

This will only install the software, but not activate the server.
Depending on your system, you might need to create a startup script 
or a systemd unit file for this.

If you're using a Debian based system (e.g. Debian, Raspbian), there
is a script that does all the work for you. Just run the following 
command:

 bash <(curl https://raw.githubusercontent.com/hifiberry/hifiberry-dsp/master/install-dsptoolkit)


sigmatcpserver
==============

This server runs in background and provides a TCP interface (port 8089) 
to access DSP functions. It is compatible with SigmaStudio. That means 
you can directly deploy DSP programs from SigmaStudio and change 
parameters online.

The server automatically dumps the so-called parameter RAM to the file 
system when it terminates. On startup, it checks for a parameter RAM 
file and if it exists it writes it back to the parameter memory. This 
ensures that parameters like volume controls, filter parameters, switch 
settings will be automatically restored even if they are not saved in 
the EEPROM. 

The server accepts the following command line parameters:

-v         Verbose output.
--alsa     Create an ALSA volume control that is synced with the volume 
           control of the running DSP program

Command line utility
====================

The dsptoolkit command is the main command line tool to communicate 
with the DSP TCP server. The command line parameters are documented
in doc/dsptoolkit.md


REW integration
===============

The software can be used to push filters created by Room Equalisation 
Wizard (REW) to the DSP.
Have a look at the guide in /doc/rew-basics.md

DSP profile format
==================

DSP profiles can be generated directly in SigmaStudio. However, to 
enable the full potential of DSP Profiles and allow DSPToolkit to 
directly control the DSP program, you need to add some additional 
metadata to the XML file.
The process to create a DSP profile is documented in /doc/dspprofiles.md