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