2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
25 #include <glib/gstdio.h>
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
30 #define LOG_PREFIX "output/srzip"
38 static int init(struct sr_output *o, GHashTable *options)
40 struct out_context *outc;
44 if (strlen(o->filename) == 0) {
45 sr_info("srzip output module requires a file name, cannot save.");
49 outc = g_malloc0(sizeof(struct out_context));
50 outc->filename = g_strdup(o->filename);
56 static int zip_create(const struct sr_output *o)
58 struct out_context *outc;
59 struct sr_channel *ch;
62 struct zip_source *versrc, *metasrc;
66 char version[1], metafile[32], *s;
69 if (outc->samplerate == 0) {
70 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
72 outc->samplerate = g_variant_get_uint64(gvar);
73 g_variant_unref(gvar);
77 /* Quietly delete it first, libzip wants replace ops otherwise. */
78 unlink(outc->filename);
79 if (!(zipfile = zip_open(outc->filename, ZIP_CREATE, &ret)))
84 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
86 if (zip_add(zipfile, "version", versrc) == -1) {
87 sr_info("Error saving version into zipfile: %s.",
88 zip_strerror(zipfile));
93 strcpy(metafile, "sigrok-meta-XXXXXX");
94 if ((tmpfile = g_mkstemp(metafile)) == -1)
97 meta = g_fopen(metafile, "wb");
98 fprintf(meta, "[global]\n");
99 fprintf(meta, "sigrok version = %s\n", SR_PACKAGE_VERSION_STRING);
100 fprintf(meta, "[device 1]\ncapturefile = logic-1\n");
101 fprintf(meta, "total probes = %d\n", g_slist_length(o->sdi->channels));
102 s = sr_samplerate_string(outc->samplerate);
103 fprintf(meta, "samplerate = %s\n", s);
106 for (l = o->sdi->channels; l; l = l->next) {
108 if (ch->type != SR_CHANNEL_LOGIC)
112 fprintf(meta, "probe%d = %s\n", ch->index + 1, ch->name);
116 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
120 if (zip_add(zipfile, "metadata", metasrc) == -1) {
125 if ((ret = zip_close(zipfile)) == -1) {
126 sr_info("Error saving zipfile: %s.", zip_strerror(zipfile));
136 static int zip_append(const struct sr_output *o, unsigned char *buf,
137 int unitsize, int length)
139 struct out_context *outc;
141 struct zip_source *logicsrc;
142 zip_int64_t num_files;
145 struct zip_source *metasrc;
149 int chunk_num, next_chunk_num, tmpfile, ret, i;
150 const char *entry_name;
151 char *metafile, tmpname[32], chunkname[16];
154 if (!(archive = zip_open(outc->filename, 0, &ret)))
157 if (zip_stat(archive, "metadata", 0, &zs) == -1)
160 metafile = g_malloc(zs.size);
161 zf = zip_fopen_index(archive, zs.index, 0);
162 zip_fread(zf, metafile, zs.size);
166 * If the file was only initialized but doesn't yet have any
167 * data it in, it won't have a unitsize field in metadata yet.
170 kf = g_key_file_new();
171 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
172 sr_err("Failed to parse metadata: %s.", error->message);
177 if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
178 if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
179 sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
182 /* Add unitsize field. */
183 g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
184 metafile = g_key_file_to_data(kf, &len, &error);
185 strcpy(tmpname, "sigrok-meta-XXXXXX");
186 if ((tmpfile = g_mkstemp(tmpname)) == -1)
188 if (write(tmpfile, metafile, len) < 0) {
189 sr_dbg("Failed to create new metadata: %s", strerror(errno));
195 if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
196 sr_err("Failed to create zip source for metadata.");
201 if (zip_replace(archive, zs.index, metasrc) == -1) {
202 sr_err("Failed to replace metadata file.");
212 num_files = zip_get_num_entries(archive, 0);
213 for (i = 0; i < num_files; i++) {
214 entry_name = zip_get_name(archive, i, 0);
215 if (strncmp(entry_name, "logic-1", 7))
217 if (strlen(entry_name) == 7) {
218 /* This file has no extra chunks, just a single "logic-1".
219 * Rename it to "logic-1-1" * and continue with chunk 2. */
220 if (zip_rename(archive, i, "logic-1-1") == -1) {
221 sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
227 } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
228 chunk_num = strtoull(entry_name + 8, NULL, 10);
229 if (chunk_num >= next_chunk_num)
230 next_chunk_num = chunk_num + 1;
233 snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
234 if (!(logicsrc = zip_source_buffer(archive, buf, length, FALSE))) {
238 if (zip_add(archive, chunkname, logicsrc) == -1) {
242 if ((ret = zip_close(archive)) == -1) {
243 sr_info("error saving session file: %s", zip_strerror(archive));
252 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
255 struct out_context *outc;
256 const struct sr_datafeed_meta *meta;
257 const struct sr_datafeed_logic *logic;
258 const struct sr_config *src;
264 if (!o || !o->sdi || !(outc = o->priv))
267 switch (packet->type) {
269 meta = packet->payload;
270 for (l = meta->config; l; l = l->next) {
272 if (src->key != SR_CONF_SAMPLERATE)
274 outc->samplerate = g_variant_get_uint64(src->data);
278 if (!outc->zip_created) {
279 if ((ret = zip_create(o)) != SR_OK)
281 outc->zip_created = TRUE;
283 logic = packet->payload;
284 ret = zip_append(o, logic->data, logic->unitsize, logic->length);
291 static int cleanup(struct sr_output *o)
293 struct out_context *outc;
296 g_free(outc->filename);
303 static struct sr_option options[] = {
307 static const struct sr_option *get_options(void)
310 options[0].def = g_variant_ref_sink(g_variant_new_string(""));
315 SR_PRIV struct sr_output_module output_srzip = {
318 .desc = "srzip session file",
319 .exts = (const char*[]){"sr", NULL},
320 .flags = SR_OUTPUT_INTERNAL_IO_HANDLING,
321 .options = get_options,