]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
session_driver: Read analog chunks from file.
[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;
f438e0c9 50 int cur_chunk;
aa48adf9 51 gboolean finished;
7d658874
BV
52};
53
f254bc4b 54static const uint32_t devopts[] = {
68ac991d
BV
55 SR_CONF_CAPTUREFILE | SR_CONF_SET,
56 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 57 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_SET,
b317d1bb 58 SR_CONF_NUM_ANALOG_CHANNELS | SR_CONF_SET,
68ac991d 59 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 60 SR_CONF_SESSIONFILE | SR_CONF_SET,
7d658874
BV
61};
62
8d4097ff 63static gboolean stream_session_data(struct sr_dev_inst *sdi)
7d658874 64{
bb7ef793 65 struct session_vdev *vdev;
7d658874 66 struct sr_datafeed_packet packet;
9c939c51 67 struct sr_datafeed_logic logic;
f438e0c9 68 struct zip_stat zs;
7d658874 69 int ret, got_data;
f438e0c9
BV
70 char capturefile[16];
71 void *buf;
7d658874 72
7d658874 73 got_data = FALSE;
102f1239 74 vdev = sdi->priv;
8d4097ff
DE
75 if (!vdev->capfile) {
76 /* No capture file opened yet, or finished with the last
77 * chunked one. */
78 if (vdev->cur_chunk == 0) {
79 /* capturefile is always the unchunked base name. */
80 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
81 /* No chunks, just a single capture file. */
82 vdev->cur_chunk = 0;
83 if (!(vdev->capfile = zip_fopen(vdev->archive,
84 vdev->capturefile, 0)))
85 return FALSE;
86 sr_dbg("Opened %s.", vdev->capturefile);
f438e0c9 87 } else {
8d4097ff
DE
88 /* Try as first chunk filename. */
89 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
f438e0c9 90 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
8d4097ff 91 vdev->cur_chunk = 1;
f438e0c9
BV
92 if (!(vdev->capfile = zip_fopen(vdev->archive,
93 capturefile, 0)))
94 return FALSE;
95 sr_dbg("Opened %s.", capturefile);
96 } else {
8d4097ff
DE
97 sr_err("No capture file '%s' in " "session file '%s'.",
98 vdev->capturefile, vdev->sessionfile);
99 return FALSE;
f438e0c9
BV
100 }
101 }
7d658874 102 } else {
8d4097ff
DE
103 /* Capture data is chunked, advance to the next chunk. */
104 vdev->cur_chunk++;
105 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
106 vdev->cur_chunk);
107 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
108 if (!(vdev->capfile = zip_fopen(vdev->archive,
109 capturefile, 0)))
110 return FALSE;
111 sr_dbg("Opened %s.", capturefile);
906921ba
ML
112 } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
113 vdev->capturefile = g_strdup_printf("analog-1-%d",
114 vdev->cur_analog_channel + 1);
115 vdev->cur_analog_channel++;
116 vdev->cur_chunk = 0;
117 return TRUE;
f438e0c9 118 } else {
8d4097ff
DE
119 /* We got all the chunks, finish up. */
120 return FALSE;
f438e0c9 121 }
7d658874
BV
122 }
123 }
124
8d4097ff
DE
125 buf = g_malloc(CHUNKSIZE);
126
127 ret = zip_fread(vdev->capfile, buf,
128 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
129 if (ret > 0) {
130 if (ret % vdev->unitsize != 0)
131 sr_warn("Read size %d not a multiple of the"
132 " unit size %d.", ret, vdev->unitsize);
133 got_data = TRUE;
134 packet.type = SR_DF_LOGIC;
135 packet.payload = &logic;
136 logic.length = ret;
137 logic.unitsize = vdev->unitsize;
138 logic.data = buf;
139 vdev->bytes_read += ret;
102f1239 140 sr_session_send(sdi, &packet);
8d4097ff
DE
141 } else {
142 /* done with this capture file */
143 zip_fclose(vdev->capfile);
144 vdev->capfile = NULL;
145 if (vdev->cur_chunk != 0) {
146 /* There might be more chunks, so don't fall through
147 * to the SR_DF_END here. */
148 got_data = TRUE;
149 }
7d658874 150 }
8d4097ff 151 g_free(buf);
7d658874 152
8d4097ff
DE
153 return got_data;
154}
155
156static int receive_data(int fd, int revents, void *cb_data)
157{
158 struct sr_dev_inst *sdi;
159 struct session_vdev *vdev;
160 struct sr_datafeed_packet packet;
161
162 (void)fd;
163 (void)revents;
164
165 sdi = cb_data;
166 vdev = sdi->priv;
167
168 if (!vdev->finished && !stream_session_data(sdi))
169 vdev->finished = TRUE;
170 if (!vdev->finished)
171 return G_SOURCE_CONTINUE;
172
173 if (vdev->capfile) {
174 zip_fclose(vdev->capfile);
175 vdev->capfile = NULL;
176 }
177 if (vdev->archive) {
178 zip_discard(vdev->archive);
179 vdev->archive = NULL;
180 }
181 packet.type = SR_DF_END;
182 packet.payload = NULL;
183 sr_session_send(sdi, &packet);
184
185 return G_SOURCE_REMOVE;
7d658874
BV
186}
187
188/* driver callbacks */
189
4f840ce9 190static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
7d658874 191{
102f1239 192 return std_init(sr_ctx, di, LOG_PREFIX);
7d658874
BV
193}
194
4f840ce9 195static int dev_clear(const struct sr_dev_driver *di)
7d658874 196{
102f1239 197 struct drv_context *drvc;
7d658874
BV
198 GSList *l;
199
41812aca 200 drvc = di->context;
102f1239 201 for (l = drvc->instances; l; l = l->next)
d3683c42 202 sr_dev_inst_free(l->data);
102f1239
BV
203 g_slist_free(drvc->instances);
204 drvc->instances = NULL;
805e9640 205
57ab7d9f 206 return SR_OK;
7d658874
BV
207}
208
6078d2c9 209static int dev_open(struct sr_dev_inst *sdi)
7d658874 210{
4f840ce9 211 struct sr_dev_driver *di;
102f1239 212 struct drv_context *drvc;
aa48adf9 213 struct session_vdev *vdev;
b53738ba 214
4f840ce9 215 di = sdi->driver;
41812aca 216 drvc = di->context;
102f1239 217 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 218 sdi->priv = vdev;
102f1239 219 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
220
221 return SR_OK;
222}
223
aa48adf9
BV
224static int dev_close(struct sr_dev_inst *sdi)
225{
8c9d4d67
JH
226 const struct session_vdev *const vdev = sdi->priv;
227 g_free(vdev->sessionfile);
228 g_free(vdev->capturefile);
229
aa48adf9
BV
230 g_free(sdi->priv);
231 sdi->priv = NULL;
232
233 return SR_OK;
234}
235
584560f1 236static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 237 const struct sr_channel_group *cg)
7d658874 238{
bb7ef793 239 struct session_vdev *vdev;
7d658874 240
53b4680f 241 (void)cg;
8f996b89 242
3f2cd87f
UH
243 if (!sdi)
244 return SR_ERR;
245
246 vdev = sdi->priv;
247
584560f1 248 switch (key) {
123e1313 249 case SR_CONF_SAMPLERATE:
3f2cd87f
UH
250 *data = g_variant_new_uint64(vdev->samplerate);
251 break;
252 case SR_CONF_CAPTURE_UNITSIZE:
253 *data = g_variant_new_uint64(vdev->unitsize);
387014de
BV
254 break;
255 default:
96ea73db 256 return SR_ERR_NA;
387014de 257 }
7d658874 258
387014de 259 return SR_OK;
7d658874
BV
260}
261
584560f1 262static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 263 const struct sr_channel_group *cg)
7d658874 264{
bb7ef793 265 struct session_vdev *vdev;
7d658874 266
53b4680f 267 (void)cg;
8f996b89 268
6f4b1868 269 vdev = sdi->priv;
7d658874 270
584560f1 271 switch (key) {
1953564a 272 case SR_CONF_SAMPLERATE:
003595ac 273 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 274 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 275 break;
1953564a 276 case SR_CONF_SESSIONFILE:
8c9d4d67 277 g_free(vdev->sessionfile);
003595ac 278 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 279 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 280 break;
1953564a 281 case SR_CONF_CAPTUREFILE:
8c9d4d67 282 g_free(vdev->capturefile);
003595ac 283 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 284 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 285 break;
1953564a 286 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 287 vdev->unitsize = g_variant_get_uint64(data);
7d658874 288 break;
3f239f08 289 case SR_CONF_NUM_LOGIC_CHANNELS:
2c38a41a 290 vdev->num_channels = g_variant_get_int32(data);
7d658874 291 break;
b317d1bb
ML
292 case SR_CONF_NUM_ANALOG_CHANNELS:
293 vdev->num_analog_channels = g_variant_get_int32(data);
294 break;
7d658874 295 default:
96ea73db 296 return SR_ERR_NA;
7d658874
BV
297 }
298
299 return SR_OK;
300}
301
584560f1 302static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 303 const struct sr_channel_group *cg)
9a6517d1 304{
9a6517d1 305 (void)sdi;
53b4680f 306 (void)cg;
9a6517d1
BV
307
308 switch (key) {
309 case SR_CONF_DEVICE_OPTIONS:
584560f1 310 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 311 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1
BV
312 break;
313 default:
96ea73db 314 return SR_ERR_NA;
9a6517d1
BV
315 }
316
317 return SR_OK;
318}
319
6078d2c9 320static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
7d658874 321{
bb7ef793 322 struct session_vdev *vdev;
ebc34738 323 int ret;
7d658874 324
102f1239 325 (void)cb_data;
7d658874 326
102f1239 327 vdev = sdi->priv;
8c9d4d67 328 vdev->bytes_read = 0;
906921ba 329 vdev->cur_analog_channel = 0;
8c9d4d67
JH
330 vdev->cur_chunk = 0;
331 vdev->finished = FALSE;
332
a885ce3e 333 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 334 vdev->capturefile);
7d658874 335
40dda2c3 336 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 337 sr_err("Failed to open session file '%s': "
9d122af8 338 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
339 return SR_ERR;
340 }
341
4afdfd46 342 /* Send header packet to the session bus. */
102f1239 343 std_session_send_df_header(sdi, LOG_PREFIX);
4afdfd46 344
7d658874 345 /* freewheeling source */
102f1239 346 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 347
7d658874
BV
348 return SR_OK;
349}
350
8d4097ff
DE
351static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
352{
353 struct session_vdev *vdev;
354
355 (void)cb_data;
356 vdev = sdi->priv;
357
358 vdev->finished = TRUE;
359
360 return SR_OK;
361}
362
b4bd7088 363/** @private */
c09f0b57 364SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 365 .name = "virtual-session",
5097b0d0
UH
366 .longname = "Session-emulating driver",
367 .api_version = 1,
6078d2c9 368 .init = init,
824fba03 369 .cleanup = dev_clear,
96ea73db
UH
370 .scan = NULL,
371 .dev_list = NULL,
824fba03 372 .dev_clear = dev_clear,
035a1078
BV
373 .config_get = config_get,
374 .config_set = config_set,
9a6517d1 375 .config_list = config_list,
6078d2c9 376 .dev_open = dev_open,
aa48adf9 377 .dev_close = dev_close,
6078d2c9 378 .dev_acquisition_start = dev_acquisition_start,
8d4097ff 379 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 380 .context = NULL,
7d658874 381};