Create README.md

Author: timschneeb

README.md

@@ -0,0 +1,101 @@
+# JDSP4Linux
+Port of the opensource version of JamesDSP to Linux
+
+This is experimental and obviously work in progress.
+Currently everything (analog modelling, bass boost, bs2b, VDC/DDCs, limiter, compression, reverbation and the stereo widener), except the convolver is implemented, and the plugin might produce crackling output if the samplerate is set incorrectly.
+
+You can find the repo of my gst-wrapper for JDSP [here](https://github.com/ThePBone/gst-plugin-jamesdsp).
+
+## Notes
+Since the gst interface of this port is very similar to viper4linux, I will temporarily use a slightly modified version of the [viper script](https://github.com/noahbliss/Viper4Linux/blob/master/viper) written by [@noahbliss](https://github.com/noahbliss).
+
+At the moment JDSP and Viper4Linux are not compatible. Trying to start them both will cause them to interfere with each other and result in no audio output.
+
+For now, I will only include the basics in the readme. More details will be added later.
+
+## Setup
+
+Install gstreamer-1.0 and some tools to build the gstreamer plugin. (If you have already installed Viper4Linux before, you can skip this step...)
+
+#### Debian
+```bash
+sudo apt-get install build-essential autoconf libtool
+sudo apt-get install gstreamer-1.0 libgstreamer-plugins-base1.0-dev libgstreamer1.0-dev 
+```
+#### Arch
+```bash
+sudo pacman -S base-devel  
+sudo pacman -S gst-plugins-good  
+```
+Clone both JDSP4Linux repos
+```bash
+git clone https://github.com/ThePBone/JDSP4Linux.git
+git clone https://github.com/ThePBone/gst-plugin-jamesdsp.git
+```
+Build the gst plugin
+```bash
+cd gst-plugin-jamesdsp  
+./autogen.sh  
+make
+```
+and install it...
+#### Debian
+```bash
+sudo cp src/.libs/libgstjdspfx.so /usr/lib/x86_64-linux-gnu/gstreamer-1.0/  
+```
+#### Arch
+```bash
+sudo cp libgstviperfx.so /usr/lib/gstreamer-1.0/  
+```
+If everything went alright gst-inspect-1.0 should display all element properties of the JDSP plugin:
+```bash
+gst-inspect-1.0 jdspfx
+```
+Copy the test-script (used to launch JDSP) to /usr/local/bin
+```bash
+sudo cp ../JDSP4Linux/jdsp_test /usr/local/bin
+```
+Create the config folder...
+```bash
+mkdir -p ~/.config/jamesdsp
+```
+and copy the default config in there.
+```bash
+cp ../JDSP4Linux/audio.conf ~/.config/jamesdsp/audio.conf
+```
+Now JDSP4Linux should be setup correctly.
+Edit the audio.conf to your liking and launch JDSP using the script (like Viper4Linux):
+```bash
+jdsp_test start
+```
+And stop it like this:
+```bash
+jdsp_test stop
+```
+Like I said, work-in-progress != stable, so use it with caution. 
+
+By the way, if you try to use a corrupted VDC file your ears will be effectively destructed by blasting white noise at them, so don't do that :) 
+
+Maybe I should implement some kind of validation ._.
+## Workarounds
+### Fix crackling/choppy sound
+_Set the default samplerate to 48000Hz in pulseaudio's config:_
+
+`sudo nano /etc/pulse/daemon.conf`
+
+Replace this line:
+`;  default-sample-rate = 44100`
+with this one:
+`default-sample-rate = 48000`
+
+And restart pulseaudio:
+```bash
+pulseaudio -k
+pulseaudio --start
+```
+### Error: no element "device"
+As described [here](https://github.com/noahbliss/Viper4Linux#configuration), you can set a custom alsa path.
+For now, you can follow the instructions over there, but make sure you drop the devices.conf in `~/.config/jamesdsp`.
+
+______________
+Please open an issue or contact me on Telegram @ThePBone if you find any bugs or have questions.