]> sigrok.org Git - libsigrok.git/blame - src/input/raw_analog.c
input: accept const sdi in feed queue API
[libsigrok.git] / src / input / raw_analog.c
CommitLineData
e6b15cb5
SB
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2015 Stefan Brüns <stefan.bruens@rwth-aachen.de>
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <config.h>
22#include <sys/types.h>
23#include <sys/stat.h>
24#include <unistd.h>
25#include <ctype.h>
26#include <string.h>
27#include <stdint.h>
28#include <libsigrok/libsigrok.h>
29#include "libsigrok-internal.h"
30
31#define LOG_PREFIX "input/raw_analog"
32
33/* How many bytes at a time to process and send to the session bus. */
9a4fd01a 34#define CHUNK_SIZE (4 * 1024 * 1024)
d9251a2c
UH
35#define DEFAULT_NUM_CHANNELS 1
36#define DEFAULT_SAMPLERATE 0
e6b15cb5
SB
37
38struct context {
39 gboolean started;
40 int fmt_index;
41 uint64_t samplerate;
42 int samplesize;
43 struct sr_datafeed_packet packet;
44 struct sr_datafeed_analog analog;
45 struct sr_analog_encoding encoding;
46 struct sr_analog_meaning meaning;
47 struct sr_analog_spec spec;
48};
49
50struct sample_format {
1393bccf 51 const char *fmt_name;
221cec31 52 struct sr_analog_encoding encoding;
e6b15cb5
SB
53};
54
1393bccf 55static const struct sample_format sample_formats[] =
e6b15cb5 56{
781ae448
SA
57 // bytes, signed, floating, bigendian, digits, digits decimal, scale, offset
58 { "S8 (-1..1)", { 1, TRUE, FALSE, FALSE, 7, FALSE, { 1, 128}, { 0, 1}}},
59 { "S8 (-128..127)", { 1, TRUE, FALSE, FALSE, 7, FALSE, { 1, 1}, { 0, 1}}},
60 { "U8 (0..1)", { 1, FALSE, FALSE, FALSE, 8, FALSE, { 1, 255}, {-1, 2}}},
61 { "U8 (0..255)", { 1, FALSE, FALSE, FALSE, 8, FALSE, { 1, 1}, { 0, 1}}},
62 { "S16_LE (-1..1)", { 2, TRUE, FALSE, FALSE, 15, FALSE, { 1, INT16_MAX + 1}, { 0, 1}}},
63 { "S16_LE (-32768..32767)", { 2, TRUE, FALSE, FALSE, 15, FALSE, { 1, 1}, { 0, 1}}},
64 { "U16_LE (0..1)", { 2, FALSE, FALSE, FALSE, 16, FALSE, { 1, UINT16_MAX}, {-1, 2}}},
65 { "U16_LE (0..65535)", { 2, FALSE, FALSE, FALSE, 16, FALSE, { 1, 1}, { 0, 1}}},
66 { "S16_BE (-1..1)", { 2, TRUE, FALSE, TRUE, 15, FALSE, { 1, INT16_MAX + 1}, { 0, 1}}},
67 { "S16_BE (-32768..32767)", { 2, TRUE, FALSE, TRUE, 15, FALSE, { 1, 1}, { 0, 1}}},
68 { "U16_BE (0..1)", { 2, FALSE, FALSE, TRUE, 16, FALSE, { 1, UINT16_MAX}, {-1, 2}}},
69 { "U16_BE (0..65535)", { 2, FALSE, FALSE, TRUE, 16, FALSE, { 1, 1}, { 0, 1}}},
70 { "S32_LE (-1..1)", { 4, TRUE, FALSE, FALSE, 31, FALSE, { 1, (uint64_t)INT32_MAX + 1}, { 0, 1}}},
71 { "S32_LE (-2147483648..2147483647)", { 4, TRUE, FALSE, FALSE, 31, FALSE, { 1, 1}, { 0, 1}}},
72 { "U32_LE (0..1)", { 4, FALSE, FALSE, FALSE, 32, FALSE, { 1, UINT32_MAX}, {-1, 2}}},
73 { "U32_LE (0..4294967295)", { 4, FALSE, FALSE, FALSE, 32, FALSE, { 1, 1}, { 0, 1}}},
74 { "S32_BE (-1..1)", { 4, TRUE, FALSE, TRUE, 31, FALSE, { 1, (uint64_t)INT32_MAX + 1}, { 0, 1}}},
75 { "S32_BE (-2147483648..2147483647)", { 4, TRUE, FALSE, TRUE, 31, FALSE, { 1, 1}, { 0, 1}}},
76 { "U32_BE (0..1)", { 4, FALSE, FALSE, TRUE, 32, FALSE, { 1, UINT32_MAX}, {-1, 2}}},
77 { "U32_BE (0..4294967295)", { 4, FALSE, FALSE, TRUE, 32, FALSE, { 1, 1}, { 0, 1}}},
78 { "FLOAT_LE", { 4, TRUE, TRUE, FALSE, 6, TRUE, { 1, 1}, { 0, 1}}},
79 { "FLOAT_BE", { 4, TRUE, TRUE, TRUE, 6, TRUE, { 1, 1}, { 0, 1}}},
80 { "FLOAT64_LE", { 8, TRUE, TRUE, FALSE, 15, TRUE, { 1, 1}, { 0, 1}}},
81 { "FLOAT64_BE", { 8, TRUE, TRUE, TRUE, 15, TRUE, { 1, 1}, { 0, 1}}},
e6b15cb5
SB
82};
83
84static int parse_format_string(const char *format)
85{
21cbe810 86 for (unsigned int i = 0; i < ARRAY_SIZE(sample_formats); i++) {
e6b15cb5
SB
87 if (!strcmp(format, sample_formats[i].fmt_name))
88 return i;
89 }
90
91 return -1;
92}
93
94static void init_context(struct context *inc, const struct sample_format *fmt, GSList *channels)
95{
96 inc->packet.type = SR_DF_ANALOG;
97 inc->packet.payload = &inc->analog;
98
99 inc->analog.data = NULL;
100 inc->analog.num_samples = 0;
101 inc->analog.encoding = &inc->encoding;
102 inc->analog.meaning = &inc->meaning;
103 inc->analog.spec = &inc->spec;
104
221cec31 105 memcpy(&inc->encoding, &fmt->encoding, sizeof(inc->encoding));
e6b15cb5
SB
106
107 inc->meaning.mq = 0;
108 inc->meaning.unit = 0;
109 inc->meaning.mqflags = 0;
110 inc->meaning.channels = channels;
111
112 inc->spec.spec_digits = 0;
113}
114
115static int init(struct sr_input *in, GHashTable *options)
116{
117 struct context *inc;
118 int num_channels;
41b8fca1 119 char channelname[16];
e6b15cb5
SB
120 const char *format;
121 int fmt_index;
122
123 num_channels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels"));
124 if (num_channels < 1) {
125 sr_err("Invalid value for numchannels: must be at least 1.");
126 return SR_ERR_ARG;
127 }
128
129 format = g_variant_get_string(g_hash_table_lookup(options, "format"), NULL);
130 if ((fmt_index = parse_format_string(format)) == -1) {
131 GString *formats = g_string_sized_new(200);
21cbe810 132 for (unsigned int i = 0; i < ARRAY_SIZE(sample_formats); i++)
e6b15cb5
SB
133 g_string_append_printf(formats, "%s ", sample_formats[i].fmt_name);
134 sr_err("Invalid format '%s': must be one of: %s.",
135 format, formats->str);
136 g_string_free(formats, TRUE);
137 return SR_ERR_ARG;
138 }
139
140 in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
141 in->priv = inc = g_malloc0(sizeof(struct context));
142
143 for (int i = 0; i < num_channels; i++) {
41b8fca1 144 snprintf(channelname, sizeof(channelname) - 1, "CH%d", i + 1);
e6b15cb5
SB
145 sr_channel_new(in->sdi, i, SR_CHANNEL_ANALOG, TRUE, channelname);
146 }
147
148 inc->samplerate = g_variant_get_uint64(g_hash_table_lookup(options, "samplerate"));
221cec31 149 inc->samplesize = sample_formats[fmt_index].encoding.unitsize * num_channels;
e6b15cb5
SB
150 init_context(inc, &sample_formats[fmt_index], in->sdi->channels);
151
152 return SR_OK;
153}
154
155static int process_buffer(struct sr_input *in)
156{
157 struct context *inc;
e6b15cb5
SB
158 unsigned int offset, chunk_size;
159
160 inc = in->priv;
161 if (!inc->started) {
bee2b016 162 std_session_send_df_header(in->sdi);
e6b15cb5
SB
163
164 if (inc->samplerate) {
f8a8d4bb
GS
165 (void)sr_session_send_meta(in->sdi, SR_CONF_SAMPLERATE,
166 g_variant_new_uint64(inc->samplerate));
e6b15cb5
SB
167 }
168
169 inc->started = TRUE;
170 }
171
172 /* Round down to the last channels * unitsize boundary. */
173 inc->analog.num_samples = CHUNK_SIZE / inc->samplesize;
174 chunk_size = inc->analog.num_samples * inc->samplesize;
175 offset = 0;
176
177 while ((offset + chunk_size) < in->buf->len) {
178 inc->analog.data = in->buf->str + offset;
179 sr_session_send(in->sdi, &inc->packet);
180 offset += chunk_size;
181 }
182
183 inc->analog.num_samples = (in->buf->len - offset) / inc->samplesize;
184 chunk_size = inc->analog.num_samples * inc->samplesize;
185 if (chunk_size > 0) {
186 inc->analog.data = in->buf->str + offset;
187 sr_session_send(in->sdi, &inc->packet);
188 offset += chunk_size;
189 }
190
191 if ((unsigned int)offset < in->buf->len) {
192 /*
193 * The incoming buffer wasn't processed completely. Stash
194 * the leftover data for next time.
195 */
196 g_string_erase(in->buf, 0, offset);
197 } else {
198 g_string_truncate(in->buf, 0);
199 }
200
201 return SR_OK;
202}
203
204static int receive(struct sr_input *in, GString *buf)
205{
206 int ret;
207
208 g_string_append_len(in->buf, buf->str, buf->len);
209
210 if (!in->sdi_ready) {
211 /* sdi is ready, notify frontend. */
212 in->sdi_ready = TRUE;
213 return SR_OK;
214 }
215
216 ret = process_buffer(in);
217
218 return ret;
219}
220
221static int end(struct sr_input *in)
222{
e6b15cb5
SB
223 struct context *inc;
224 int ret;
225
226 if (in->sdi_ready)
227 ret = process_buffer(in);
228 else
229 ret = SR_OK;
230
231 inc = in->priv;
3be42bc2 232 if (inc->started)
bee2b016 233 std_session_send_df_end(in->sdi);
e6b15cb5
SB
234
235 return ret;
236}
237
238static struct sr_option options[] = {
867293a1
UH
239 { "numchannels", "Number of analog channels", "The number of (analog) channels in the data", NULL, NULL },
240 { "samplerate", "Sample rate (Hz)", "The sample rate of the (analog) data in Hz", NULL, NULL },
241 { "format", "Data format", "The format of the data (data type, signedness, endianness)", NULL, NULL },
e6b15cb5
SB
242 ALL_ZERO
243};
244
245static const struct sr_option *get_options(void)
246{
e6b15cb5
SB
247 if (!options[0].def) {
248 options[0].def = g_variant_ref_sink(g_variant_new_int32(DEFAULT_NUM_CHANNELS));
249 options[1].def = g_variant_ref_sink(g_variant_new_uint64(DEFAULT_SAMPLERATE));
250 options[2].def = g_variant_ref_sink(g_variant_new_string(sample_formats[0].fmt_name));
21cbe810 251 for (unsigned int i = 0; i < ARRAY_SIZE(sample_formats); i++) {
e6b15cb5
SB
252 options[2].values = g_slist_append(options[2].values,
253 g_variant_ref_sink(g_variant_new_string(sample_formats[i].fmt_name)));
254 }
255 }
256
257 return options;
258}
259
260static void cleanup(struct sr_input *in)
261{
9e850040
SA
262 g_free(in->priv);
263 in->priv = NULL;
e6b15cb5 264
e6b15cb5
SB
265 g_variant_unref(options[0].def);
266 g_variant_unref(options[1].def);
267 g_variant_unref(options[2].def);
268 g_slist_free_full(options[2].values, (GDestroyNotify)g_variant_unref);
e6b15cb5
SB
269}
270
4c55ea47
SA
271static int reset(struct sr_input *in)
272{
273 struct context *inc = in->priv;
274
4c55ea47 275 inc->started = FALSE;
9e850040 276
4c55ea47
SA
277 g_string_truncate(in->buf, 0);
278
279 return SR_OK;
280}
281
e6b15cb5
SB
282SR_PRIV struct sr_input_module input_raw_analog = {
283 .id = "raw_analog",
284 .name = "RAW analog",
b20eb520 285 .desc = "Raw analog data without header",
e6b15cb5
SB
286 .exts = (const char*[]){"raw", "bin", NULL},
287 .options = get_options,
288 .init = init,
289 .receive = receive,
290 .end = end,
291 .cleanup = cleanup,
4c55ea47 292 .reset = reset,
e6b15cb5 293};