summaryrefslogtreecommitdiff
path: root/include/rtl-sdr.h
blob: 33370bc5aa95bdf62ff9d57a5723246f53e56868 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * rtl-sdr, a poor man's SDR using a Realtek RTL2832 based DVB-stick
 * Copyright (C) 2012 by Steve Markgraf <steve@steve-m.de>
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __RTL_SDR_H
#define __RTL_SDR_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

typedef int rtlsdr_dev_t;

/* must be called once before using any other library functions */
int rtlsdr_init(void);

/* must be called once at application shutdown */
void rtlsdr_exit(void);

uint32_t rtlsdr_get_device_count(void);

const char *rtlsdr_get_device_name(uint32_t index);

rtlsdr_dev_t *rtlsdr_open(uint32_t index);

int rtlsdr_close(rtlsdr_dev_t *dev);

/* configuration functions */

int rtlsdr_set_center_freq(rtlsdr_dev_t *dev, uint32_t freq);

int rtlsdr_get_center_freq(rtlsdr_dev_t *dev);

int rtlsdr_set_freq_correction(rtlsdr_dev_t *dev, int ppm);

int rtlsdr_get_freq_correction(rtlsdr_dev_t *dev);

int rtlsdr_set_tuner_gain(rtlsdr_dev_t *dev, int gain);

int rtlsdr_get_tuner_gain(rtlsdr_dev_t *dev);

/* this will select the baseband filters according to the requested sample rate */
int rtlsdr_set_sample_rate(rtlsdr_dev_t *dev, uint32_t rate);

int rtlsdr_get_sample_rate(rtlsdr_dev_t *dev);

/* streaming functions */

int rtlsdr_reset_buffer(rtlsdr_dev_t *dev);

int rtlsdr_read_sync(rtlsdr_dev_t *dev, void *buf, uint32_t len, uint32_t *n_read);

typedef void(*rtlsdr_async_read_cb_t)(const char *buf, uint32_t len, void *ctx);

int rtlsdr_async_loop(rtlsdr_dev_t *dev, rtlsdr_async_read_cb_t cb, void *ctx);

#ifdef __cplusplus
}
#endif

#endif /* __RTL_SDR_H */