sdr.h File Reference

SDR input from RTLSDR or SoapySDR. More...

Go to the source code of this file.

Typedefs
typedef struct sdr_dev	sdr_dev_t
typedef void(*	sdr_read_cb_t) (unsigned char *buf, uint32_t len, void *ctx)

Functions
int	sdr_open (sdr_dev_t **out_dev, int *sample_size, char *dev_query, int verbose)
	Find the closest matching device, optionally report status. More...
int	sdr_close (sdr_dev_t *dev)
	Close the device, optionally report status. More...
int	sdr_set_center_freq (sdr_dev_t *dev, uint32_t freq, int verbose)
	Set device frequency, optionally report status. More...
uint32_t	sdr_get_center_freq (sdr_dev_t *dev)
	Get device frequency. More...
int	sdr_set_freq_correction (sdr_dev_t *dev, int ppm, int verbose)
	Set the frequency correction value for the device, optionally report status. More...
int	sdr_set_auto_gain (sdr_dev_t *dev, int verbose)
	Enable auto gain, optionally report status. More...
int	sdr_set_tuner_gain (sdr_dev_t *dev, char *gain_str, int verbose)
	Set tuner gain or gain elements, optionally report status. More...
int	sdr_set_sample_rate (sdr_dev_t *dev, uint32_t rate, int verbose)
	Set device sample rate, optionally report status. More...
int	sdr_set_antenna (sdr_dev_t *dev, char *antenna_str, int verbose)
	Set device antenna. More...
uint32_t	sdr_get_sample_rate (sdr_dev_t *dev)
	Get device sample rate. More...
int	sdr_apply_settings (sdr_dev_t *dev, char const *sdr_settings, int verbose)
	Apply a list of sdr settings. More...
int	sdr_activate (sdr_dev_t *dev)
	Activate stream (only needed for SoapySDR). More...
int	sdr_deactivate (sdr_dev_t *dev)
	Deactivate stream (only needed for SoapySDR). More...
int	sdr_reset (sdr_dev_t *dev, int verbose)
	Reset buffer (only needed for RTL-SDR), optionally report status. More...
int	sdr_start (sdr_dev_t *dev, sdr_read_cb_t cb, void *ctx, uint32_t buf_num, uint32_t buf_len)
int	sdr_stop (sdr_dev_t *dev)

Detailed Description

SDR input from RTLSDR or SoapySDR.

Copyright (C) 2018 Christian Zuckschwerdt

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Typedef Documentation

sdr_dev_t

typedef struct sdr_dev sdr_dev_t

sdr_read_cb_t

typedef void(* sdr_read_cb_t) (unsigned char *buf, uint32_t len, void *ctx)

Function Documentation

sdr_activate()

int sdr_activate

(

sdr_dev_t *

dev

)

Activate stream (only needed for SoapySDR).

Parameters

dev	the device handle

Returns

0 on success

References sdr_dev::soapy_dev, and sdr_dev::soapy_stream.

Referenced by main().

sdr_apply_settings()

int sdr_apply_settings	(	sdr_dev_t *	dev,
		char const *	sdr_settings,
		int	verbose
	)

Apply a list of sdr settings.

Parameters

dev	the device handle
sdr_settings	keyword list of settings
verbose	the verbosity level for reports to stderr

Returns

0 on success

References atouint32_metric(), and sdr_dev::soapy_dev.

Referenced by main().

sdr_close()

int sdr_close

(

sdr_dev_t *

dev

)

Close the device, optionally report status.

Parameters

dev	the device handle
verbose	the verbosity level for reports to stderr

Returns

0 on success

References sdr_dev::buffer, sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, rtltcp_close(), and sdr_dev::soapy_dev.

Referenced by r_free_cfg().

sdr_deactivate()

int sdr_deactivate

(

sdr_dev_t *

dev

)

Deactivate stream (only needed for SoapySDR).

Parameters

dev	the device handle

Returns

0 on success

References sdr_dev::soapy_dev, and sdr_dev::soapy_stream.

Referenced by r_free_cfg().

sdr_get_center_freq()

uint32_t sdr_get_center_freq

(

sdr_dev_t *

dev

)

Get device frequency.

Parameters

dev	the device handle

Returns

frequency in Hz on success, 0 otherwise

References sdr_dev::rtlsdr_dev, and sdr_dev::soapy_dev.

Referenced by sdr_set_center_freq().

sdr_get_sample_rate()

uint32_t sdr_get_sample_rate

(

sdr_dev_t *

dev

)

Get device sample rate.

Parameters

dev	the device handle

Returns

sample rate in samples/second on success, 0 otherwise

References sdr_dev::rtlsdr_dev, and sdr_dev::soapy_dev.

Referenced by sdr_set_sample_rate().

sdr_open()

int sdr_open	(	sdr_dev_t **	out_dev,
		int *	sample_size,
		char *	dev_query,
		int	verbose
	)

Find the closest matching device, optionally report status.

Parameters

out_dev	device output returned
sample_size	stream output sample width returned
dev_query	a string to be parsed as device spec
verbose	the verbosity level for reports to stderr

Returns

dev 0 if successful

References rtltcp_open(), sdr_open_rtl(), and sdr_open_soapy().

Referenced by main().

sdr_reset()

int sdr_reset	(	sdr_dev_t *	dev,
		int	verbose
	)

Reset buffer (only needed for RTL-SDR), optionally report status.

Parameters

dev	the device handle
verbose	the verbosity level for reports to stderr

Returns

0 on success

References sdr_dev::rtlsdr_dev.

Referenced by main().

sdr_set_antenna()

int sdr_set_antenna	(	sdr_dev_t *	dev,
		char *	antenna_str,
		int	verbose
	)

Set device antenna.

Parameters

dev	the device handle
antenna_str	name of the antenna (example 'Tuner 2 50 ohm')
verbose	the verbosity level for reports to stderr

Returns

0 on success

References sdr_dev::soapy_dev.

sdr_set_auto_gain()

int sdr_set_auto_gain	(	sdr_dev_t *	dev,
		int	verbose
	)

Enable auto gain, optionally report status.

Parameters

dev	the device handle
verbose	the verbosity level for reports to stderr

Returns

0 on success

References sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, rtltcp_command(), sdr_dev::soapy_dev, and soapysdr_auto_gain().

Referenced by sdr_set_tuner_gain().

sdr_set_center_freq()

int sdr_set_center_freq	(	sdr_dev_t *	dev,
		uint32_t	freq,
		int	verbose
	)

Set device frequency, optionally report status.

Parameters

dev	the device handle
frequency	in Hz
verbose	the verbosity level for reports to stderr

Returns

0 on success

References nice_freq(), sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, rtltcp_command(), sdr_get_center_freq(), and sdr_dev::soapy_dev.

Referenced by main().

sdr_set_freq_correction()

int sdr_set_freq_correction	(	sdr_dev_t *	dev,
		int	ppm,
		int	verbose
	)

Set the frequency correction value for the device, optionally report status.

Parameters

dev	the device handle
ppm_error	correction value in parts per million (ppm)
verbose	the verbosity level for reports to stderr

Returns

0 on success

References sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, rtltcp_command(), and sdr_dev::soapy_dev.

Referenced by main().

sdr_set_sample_rate()

int sdr_set_sample_rate	(	sdr_dev_t *	dev,
		uint32_t	rate,
		int	verbose
	)

Set device sample rate, optionally report status.

Parameters

dev	the device handle
samp_rate	in samples/second
verbose	the verbosity level for reports to stderr

Returns

0 on success

References sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, rtltcp_command(), sdr_get_sample_rate(), and sdr_dev::soapy_dev.

Referenced by main().

sdr_set_tuner_gain()

int sdr_set_tuner_gain	(	sdr_dev_t *	dev,
		char *	gain_str,
		int	verbose
	)

Set tuner gain or gain elements, optionally report status.

Parameters

dev	the device handle
gain_str	in tenths of a dB for RTL-SDR, string of gain element pairs (example LNA=40,VGA=20,AMP=0), or string of overall gain, in dB
verbose	the verbosity level for reports to stderr

Returns

0 on success

References sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, rtltcp_command(), sdr_set_auto_gain(), sdr_dev::soapy_dev, and soapysdr_gain_str_set().

Referenced by main().

sdr_start()

int sdr_start	(	sdr_dev_t *	dev,
		sdr_read_cb_t	cb,
		void *	ctx,
		uint32_t	buf_num,
		uint32_t	buf_len
	)

References sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, rtltcp_read_loop(), sdr_dev::soapy_dev, and soapysdr_read_loop().

Referenced by main().

sdr_stop()

int sdr_stop

(

sdr_dev_t *

dev

)

References sdr_dev::rtl_tcp, sdr_dev::rtlsdr_dev, sdr_dev::running, and sdr_dev::soapy_dev.

Referenced by sdr_callback(), and sighandler().