Updated plugins documentation with minimal baseband sample rate requirements where necessary

pull/304/head v4.5.0
f4exb 2019-03-02 12:39:47 +01:00
rodzic e0046b3df6
commit 749cd82b51
3 zmienionych plików z 8 dodań i 2 usunięć

Wyświetl plik

@ -14,6 +14,8 @@ The modulation and standard is automatically detected and switched depending on
To enable this plugin at compile time you will need to have DSDcc installed in your system. Please follow instructions in [DSDcc readme](https://github.com/f4exb/dsdcc/blob/master/Readme.md) to build and install DSDcc. If you install it in a custom location say `/opt/install/dsdcc` you will need to add these defines to the cmake command: `-DDSDCC_DIR=/opt/install/dsdcc`
⚠ A minimum of 48 kS/s I/Q sample rate in the baseband is required for the demodulator/decoder to work correctly.
<h2>DV serial device support</h2>
You can use a serial device connected to your system that implements and exposes the packet interface of the AMBE3000 chip. This can be for example a ThumbDV USB dongle. In order to support DV serial devices in your system you will need two things:

Wyświetl plik

@ -4,6 +4,8 @@
This plugin can be used to demodulate a signal following the [FreeDV digital voice protocol](https://freedv.org/).
&#9888; A minimum of 48 kS/s I/Q sample rate in the baseband is required in 2400A mode for the demodulator/decoder to work correctly. Other modes only require 8 kS/s.
<h2>Interface</h2>
![FreeDV Demodulator plugin GUI](../../../doc/img/FreeDVDemod_plugin.png)

Wyświetl plik

@ -4,6 +4,8 @@
This plugin can be used to generate a signal following the [FreeDV digital voice protocol](https://freedv.org/).
&#9888; A minimum of 48 kS/s I/Q sample rate in the baseband is required in 2400A mode for the coder/modulator to work correctly. Other modes only require 8 kS/s however such a low rate is not recommended and at least 48 kS/s should be used anyway.
<h2>Interface</h2>
![FreeDV Modulator plugin GUI](../../../doc/img/FreeDVMod_plugin.png)
@ -120,8 +122,8 @@ The path to the selected audio file to be played or dots if unselected
<h4>12.1: Audio file select</h4>
Opens a file dialog to select the audio file to be played. It must be 48 kHz F32LE raw format. If binaural mode is selected it takes a 2 channel (stereo) file else it should be mono.
Using sox a .wav file can be converted with this command: `sox piano.wav -t raw -r 48k -c 1 -b 32 -L -e float piano.raw` (mono) or `sox piano.wav -t raw -r 48k -c 2 -b 32 -L -e float piano.raw` (stereo)
Opens a file dialog to select the audio file to be played. It must be 8 kHz S16LE single (mono) channel raw format.
Using sox a .wav file can be converted with this command: `sox piano.wav -t raw -r 8k -c 1 -b 16 -L -e signed piano.raw`
<h4>12.2: Audio file loop</h4>