Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
williamyang98 committed Apr 6, 2023
1 parent aa763c5 commit 1ff3c76
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@ As much of the internal state of the demodulator is shown for academic purposes.
SIMD is employed to improve DSP performance on x86 processors.

## Instructions
1. Download program from releases page.
2. Unzip and extract folder.
3. Run <code>./bin/rtl_sdr.exe -f [fm_frequency] -s 1.024e6 -g 20 | ./main.exe</code>
1. Setup rtlsdr radio drivers according to [here](https://www.rtl-sdr.com/rtl-sdr-quick-start-guide/)
2. Plug in your RTLSDR Blog v3 dongle
3. Download program from releases page.
4. Unzip and extract folder.
5. Run <code>./fm_demod_tuner.exe</code>

## Explanation
FM radio contains many data components which are present after FM demodulation.
Expand Down Expand Up @@ -49,4 +51,10 @@ The RDS signal contains the following data described [here](https://en.wikipedia

The document used to decode the standard (partially) is located [here](docs/EN50067_RDS_Standard.pdf).

It usually contains the programme identifier code and additional descriptive text and metadata.
It usually contains the programme identifier code and additional descriptive text and metadata.

## Running from offline data
1. Download FM signal recording from [here](https://github.com/FiendChain/FM-Radio/releases/tag/sample_data).
2. Extract <code>*.pcm</code> from archive
3. Download program from releases page
4. Run <code>./fm_demod_no_tuner.exe -i \<recording\>.pcm</code>
2 changes: 1 addition & 1 deletion src/rtl_sdr.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ extern "C" {
#include <rtl-sdr.h>
}

constexpr int DEFAULT_SAMPLE_RATE = 2048000;
constexpr int DEFAULT_SAMPLE_RATE = 1024000;
constexpr int DEFAULT_BUF_LENGTH = 16*16384;
constexpr int MINIMAL_BUF_LENGTH = 512;
constexpr int MAXIMAL_BUF_LENGTH = 256*16384;
Expand Down

0 comments on commit 1ff3c76

Please sign in to comment.