]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
Enable loading of session files without the capture file defined
[libsigrok.git] / src / session_driver.c
CommitLineData
7d658874 1/*
50985c20 2 * This file is part of the libsigrok project.
7d658874 3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7d658874
BV
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
6ec6c43b 20#include <config.h>
7d658874
BV
21#include <sys/types.h>
22#include <sys/stat.h>
23#include <fcntl.h>
24#include <unistd.h>
25#include <sys/time.h>
26#include <zip.h>
c1aae900 27#include <libsigrok/libsigrok.h>
45c59c8b 28#include "libsigrok-internal.h"
7d658874 29
3544f848 30#define LOG_PREFIX "virtual-session"
a885ce3e 31
7d658874 32/* size of payloads sent across the session bus */
b4bd7088 33/** @cond PRIVATE */
8ff6afc9 34#define CHUNKSIZE (512 * 1024)
b4bd7088 35/** @endcond */
7d658874 36
102f1239 37SR_PRIV struct sr_dev_driver session_driver_info;
102f1239 38
bb7ef793 39struct session_vdev {
40dda2c3 40 char *sessionfile;
7d658874
BV
41 char *capturefile;
42 struct zip *archive;
43 struct zip_file *capfile;
cb1e389c 44 int bytes_read;
7d658874
BV
45 uint64_t samplerate;
46 int unitsize;
fca75cbb 47 int num_channels;
b317d1bb 48 int num_analog_channels;
906921ba 49 int cur_analog_channel;
2dc40815 50 GArray *analog_channels;
f438e0c9 51 int cur_chunk;
aa48adf9 52 gboolean finished;
7d658874
BV
53};
54
f254bc4b 55static const uint32_t devopts[] = {
68ac991d
BV
56 SR_CONF_CAPTUREFILE | SR_CONF_SET,
57 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 58 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_SET,
b317d1bb 59 SR_CONF_NUM_ANALOG_CHANNELS | SR_CONF_SET,
68ac991d 60 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 61 SR_CONF_SESSIONFILE | SR_CONF_SET,
7d658874
BV
62};
63
8d4097ff 64static gboolean stream_session_data(struct sr_dev_inst *sdi)
7d658874 65{
bb7ef793 66 struct session_vdev *vdev;
7d658874 67 struct sr_datafeed_packet packet;
9c939c51 68 struct sr_datafeed_logic logic;
2dc40815 69 struct sr_datafeed_analog_old analog;
f438e0c9 70 struct zip_stat zs;
7d658874 71 int ret, got_data;
f438e0c9
BV
72 char capturefile[16];
73 void *buf;
7d658874 74
7d658874 75 got_data = FALSE;
102f1239 76 vdev = sdi->priv;
7c69b528 77
8d4097ff
DE
78 if (!vdev->capfile) {
79 /* No capture file opened yet, or finished with the last
80 * chunked one. */
7c69b528 81 if (vdev->capturefile && (vdev->cur_chunk == 0)) {
8d4097ff
DE
82 /* capturefile is always the unchunked base name. */
83 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
84 /* No chunks, just a single capture file. */
85 vdev->cur_chunk = 0;
86 if (!(vdev->capfile = zip_fopen(vdev->archive,
87 vdev->capturefile, 0)))
88 return FALSE;
89 sr_dbg("Opened %s.", vdev->capturefile);
f438e0c9 90 } else {
8d4097ff
DE
91 /* Try as first chunk filename. */
92 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
f438e0c9 93 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
8d4097ff 94 vdev->cur_chunk = 1;
f438e0c9
BV
95 if (!(vdev->capfile = zip_fopen(vdev->archive,
96 capturefile, 0)))
97 return FALSE;
98 sr_dbg("Opened %s.", capturefile);
99 } else {
8d4097ff
DE
100 sr_err("No capture file '%s' in " "session file '%s'.",
101 vdev->capturefile, vdev->sessionfile);
102 return FALSE;
f438e0c9
BV
103 }
104 }
7d658874 105 } else {
8d4097ff
DE
106 /* Capture data is chunked, advance to the next chunk. */
107 vdev->cur_chunk++;
108 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
109 vdev->cur_chunk);
110 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
111 if (!(vdev->capfile = zip_fopen(vdev->archive,
112 capturefile, 0)))
113 return FALSE;
114 sr_dbg("Opened %s.", capturefile);
906921ba
ML
115 } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
116 vdev->capturefile = g_strdup_printf("analog-1-%d",
e5b280e4 117 vdev->num_channels + vdev->cur_analog_channel + 1);
906921ba
ML
118 vdev->cur_analog_channel++;
119 vdev->cur_chunk = 0;
120 return TRUE;
f438e0c9 121 } else {
8d4097ff
DE
122 /* We got all the chunks, finish up. */
123 return FALSE;
f438e0c9 124 }
7d658874
BV
125 }
126 }
127
8d4097ff
DE
128 buf = g_malloc(CHUNKSIZE);
129
130 ret = zip_fread(vdev->capfile, buf,
131 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
132 if (ret > 0) {
8d4097ff 133 got_data = TRUE;
2dc40815
ML
134 if (vdev->cur_analog_channel != 0) {
135 packet.type = SR_DF_ANALOG_OLD;
136 packet.payload = &analog;
137 analog.channels = g_slist_prepend(NULL,
138 g_array_index(vdev->analog_channels,
139 struct sr_channel *, vdev->cur_analog_channel - 1));
140 analog.num_samples = ret / sizeof(float);
141 analog.mq = SR_MQ_VOLTAGE;
142 analog.unit = SR_UNIT_VOLT;
143 analog.mqflags = SR_MQFLAG_DC;
144 analog.data = (float *) buf;
145 } else {
146 if (ret % vdev->unitsize != 0)
147 sr_warn("Read size %d not a multiple of the"
148 " unit size %d.", ret, vdev->unitsize);
149 packet.type = SR_DF_LOGIC;
150 packet.payload = &logic;
151 logic.length = ret;
152 logic.unitsize = vdev->unitsize;
153 logic.data = buf;
154 }
8d4097ff 155 vdev->bytes_read += ret;
102f1239 156 sr_session_send(sdi, &packet);
8d4097ff
DE
157 } else {
158 /* done with this capture file */
159 zip_fclose(vdev->capfile);
160 vdev->capfile = NULL;
161 if (vdev->cur_chunk != 0) {
162 /* There might be more chunks, so don't fall through
163 * to the SR_DF_END here. */
164 got_data = TRUE;
165 }
7d658874 166 }
8d4097ff 167 g_free(buf);
7d658874 168
8d4097ff
DE
169 return got_data;
170}
171
172static int receive_data(int fd, int revents, void *cb_data)
173{
174 struct sr_dev_inst *sdi;
175 struct session_vdev *vdev;
176 struct sr_datafeed_packet packet;
177
178 (void)fd;
179 (void)revents;
180
181 sdi = cb_data;
182 vdev = sdi->priv;
183
184 if (!vdev->finished && !stream_session_data(sdi))
185 vdev->finished = TRUE;
186 if (!vdev->finished)
187 return G_SOURCE_CONTINUE;
188
189 if (vdev->capfile) {
190 zip_fclose(vdev->capfile);
191 vdev->capfile = NULL;
192 }
193 if (vdev->archive) {
194 zip_discard(vdev->archive);
195 vdev->archive = NULL;
196 }
197 packet.type = SR_DF_END;
198 packet.payload = NULL;
199 sr_session_send(sdi, &packet);
200
201 return G_SOURCE_REMOVE;
7d658874
BV
202}
203
204/* driver callbacks */
205
4f840ce9 206static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
7d658874 207{
102f1239 208 return std_init(sr_ctx, di, LOG_PREFIX);
7d658874
BV
209}
210
4f840ce9 211static int dev_clear(const struct sr_dev_driver *di)
7d658874 212{
102f1239 213 struct drv_context *drvc;
7d658874
BV
214 GSList *l;
215
41812aca 216 drvc = di->context;
102f1239 217 for (l = drvc->instances; l; l = l->next)
d3683c42 218 sr_dev_inst_free(l->data);
102f1239
BV
219 g_slist_free(drvc->instances);
220 drvc->instances = NULL;
805e9640 221
57ab7d9f 222 return SR_OK;
7d658874
BV
223}
224
6078d2c9 225static int dev_open(struct sr_dev_inst *sdi)
7d658874 226{
4f840ce9 227 struct sr_dev_driver *di;
102f1239 228 struct drv_context *drvc;
aa48adf9 229 struct session_vdev *vdev;
b53738ba 230
4f840ce9 231 di = sdi->driver;
41812aca 232 drvc = di->context;
102f1239 233 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 234 sdi->priv = vdev;
102f1239 235 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
236
237 return SR_OK;
238}
239
aa48adf9
BV
240static int dev_close(struct sr_dev_inst *sdi)
241{
8c9d4d67
JH
242 const struct session_vdev *const vdev = sdi->priv;
243 g_free(vdev->sessionfile);
244 g_free(vdev->capturefile);
245
aa48adf9
BV
246 g_free(sdi->priv);
247 sdi->priv = NULL;
248
249 return SR_OK;
250}
251
584560f1 252static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 253 const struct sr_channel_group *cg)
7d658874 254{
bb7ef793 255 struct session_vdev *vdev;
7d658874 256
53b4680f 257 (void)cg;
8f996b89 258
3f2cd87f
UH
259 if (!sdi)
260 return SR_ERR;
261
262 vdev = sdi->priv;
263
584560f1 264 switch (key) {
123e1313 265 case SR_CONF_SAMPLERATE:
3f2cd87f
UH
266 *data = g_variant_new_uint64(vdev->samplerate);
267 break;
268 case SR_CONF_CAPTURE_UNITSIZE:
269 *data = g_variant_new_uint64(vdev->unitsize);
387014de
BV
270 break;
271 default:
96ea73db 272 return SR_ERR_NA;
387014de 273 }
7d658874 274
387014de 275 return SR_OK;
7d658874
BV
276}
277
584560f1 278static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 279 const struct sr_channel_group *cg)
7d658874 280{
bb7ef793 281 struct session_vdev *vdev;
7d658874 282
53b4680f 283 (void)cg;
8f996b89 284
6f4b1868 285 vdev = sdi->priv;
7d658874 286
584560f1 287 switch (key) {
1953564a 288 case SR_CONF_SAMPLERATE:
003595ac 289 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 290 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 291 break;
1953564a 292 case SR_CONF_SESSIONFILE:
8c9d4d67 293 g_free(vdev->sessionfile);
003595ac 294 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 295 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 296 break;
1953564a 297 case SR_CONF_CAPTUREFILE:
8c9d4d67 298 g_free(vdev->capturefile);
003595ac 299 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 300 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 301 break;
1953564a 302 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 303 vdev->unitsize = g_variant_get_uint64(data);
7d658874 304 break;
3f239f08 305 case SR_CONF_NUM_LOGIC_CHANNELS:
2c38a41a 306 vdev->num_channels = g_variant_get_int32(data);
7d658874 307 break;
b317d1bb
ML
308 case SR_CONF_NUM_ANALOG_CHANNELS:
309 vdev->num_analog_channels = g_variant_get_int32(data);
310 break;
7d658874 311 default:
96ea73db 312 return SR_ERR_NA;
7d658874
BV
313 }
314
315 return SR_OK;
316}
317
584560f1 318static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 319 const struct sr_channel_group *cg)
9a6517d1 320{
9a6517d1 321 (void)sdi;
53b4680f 322 (void)cg;
9a6517d1
BV
323
324 switch (key) {
325 case SR_CONF_DEVICE_OPTIONS:
584560f1 326 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 327 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1
BV
328 break;
329 default:
96ea73db 330 return SR_ERR_NA;
9a6517d1
BV
331 }
332
333 return SR_OK;
334}
335
6078d2c9 336static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
7d658874 337{
bb7ef793 338 struct session_vdev *vdev;
ebc34738 339 int ret;
2dc40815
ML
340 GSList *l;
341 struct sr_channel *ch;
7d658874 342
102f1239 343 (void)cb_data;
7d658874 344
102f1239 345 vdev = sdi->priv;
8c9d4d67 346 vdev->bytes_read = 0;
906921ba 347 vdev->cur_analog_channel = 0;
2dc40815
ML
348 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
349 sizeof(struct sr_channel *), vdev->num_analog_channels);
350 for (l = sdi->channels; l; l = l->next) {
351 ch = l->data;
352 if (ch->type == SR_CHANNEL_ANALOG)
353 g_array_append_val(vdev->analog_channels, ch);
354 }
8c9d4d67
JH
355 vdev->cur_chunk = 0;
356 vdev->finished = FALSE;
357
a885ce3e 358 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 359 vdev->capturefile);
7d658874 360
40dda2c3 361 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 362 sr_err("Failed to open session file '%s': "
9d122af8 363 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
364 return SR_ERR;
365 }
366
4afdfd46 367 /* Send header packet to the session bus. */
102f1239 368 std_session_send_df_header(sdi, LOG_PREFIX);
4afdfd46 369
7d658874 370 /* freewheeling source */
102f1239 371 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 372
7d658874
BV
373 return SR_OK;
374}
375
8d4097ff
DE
376static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
377{
378 struct session_vdev *vdev;
379
380 (void)cb_data;
381 vdev = sdi->priv;
382
383 vdev->finished = TRUE;
384
385 return SR_OK;
386}
387
b4bd7088 388/** @private */
c09f0b57 389SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 390 .name = "virtual-session",
5097b0d0
UH
391 .longname = "Session-emulating driver",
392 .api_version = 1,
6078d2c9 393 .init = init,
824fba03 394 .cleanup = dev_clear,
96ea73db
UH
395 .scan = NULL,
396 .dev_list = NULL,
824fba03 397 .dev_clear = dev_clear,
035a1078
BV
398 .config_get = config_get,
399 .config_set = config_set,
9a6517d1 400 .config_list = config_list,
6078d2c9 401 .dev_open = dev_open,
aa48adf9 402 .dev_close = dev_close,
6078d2c9 403 .dev_acquisition_start = dev_acquisition_start,
8d4097ff 404 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 405 .context = NULL,
7d658874 406};