Minor cosmetics.
[sigrok-cli.git] / session.c
index 39eb164942c447a57bba67e04ad3e9e7d7fee06a..9fa545ec690a35fc5b6f3e742df2eb472ec5ce0c 100644 (file)
--- a/session.c
+++ b/session.c
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrok-cli.h"
 #include <glib.h>
 #include <glib/gstdio.h>
 #include <string.h>
 #include <stdlib.h>
+#include "sigrok-cli.h"
 
-static int default_output_format = FALSE;
 static uint64_t limit_samples = 0;
 static uint64_t limit_frames = 0;
+static char *srzip_and_filename = NULL;
 
 #ifdef HAVE_SRD
 extern struct srd_session *srd_sess;
@@ -36,21 +36,25 @@ static int set_limit_time(const struct sr_dev_inst *sdi)
        GVariant *gvar;
        uint64_t time_msec;
        uint64_t samplerate;
+       struct sr_dev_driver *driver;
+
+       driver = sr_dev_inst_driver_get(sdi);
 
        if (!(time_msec = sr_parse_timestring(opt_time))) {
                g_critical("Invalid time '%s'", opt_time);
                return SR_ERR;
        }
 
-       if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
+       if (config_key_has_cap(driver, sdi, NULL, SR_CONF_LIMIT_MSEC, SR_CONF_SET)) {
                gvar = g_variant_new_uint64(time_msec);
                if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
                        g_critical("Failed to configure time limit.");
                        return SR_ERR;
                }
-       } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
-               /* Convert to samples based on the samplerate.  */
-               sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
+       } else if (config_key_has_cap(driver, sdi, NULL, SR_CONF_SAMPLERATE,
+                       SR_CONF_GET | SR_CONF_SET)) {
+               /* Convert to samples based on the samplerate. */
+               sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
                samplerate = g_variant_get_uint64(gvar);
                g_variant_unref(gvar);
                limit_samples = (samplerate) * time_msec / (uint64_t)1000;
@@ -71,55 +75,24 @@ static int set_limit_time(const struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-GHashTable *generic_arg_to_opt(const struct sr_option *opts, GHashTable *genargs)
-{
-       GHashTable *hash;
-       GVariant *gvar;
-       const struct sr_option *opt;
-       char *s;
-
-       hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
-                       (GDestroyNotify)g_variant_unref);
-       for (opt = opts; opt->id && opt->def; opt++) {
-               if (!(s = g_hash_table_lookup(genargs, opt->id)))
-                       continue;
-               if (g_variant_is_of_type(opt->def, G_VARIANT_TYPE_UINT32)) {
-                       gvar = g_variant_new_uint32(strtoul(s, NULL, 10));
-                       g_hash_table_insert(hash, g_strdup(opt->id),
-                                       g_variant_ref_sink(gvar));
-               } else if (g_variant_is_of_type(opt->def, G_VARIANT_TYPE_DOUBLE)) {
-                       gvar = g_variant_new_double(strtod(s, NULL));
-                       g_hash_table_insert(hash, g_strdup(opt->id),
-                                       g_variant_ref_sink(gvar));
-               } else {
-                       g_critical("Don't know GVariant type for option '%s'!", opt->id);
-                }
-       }
-
-       return hash;
-}
-
 const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi)
 {
        const struct sr_output_module *omod;
-       const struct sr_option *opts;
+       const struct sr_option **options;
        const struct sr_output *o;
        GHashTable *fmtargs, *fmtopts;
+       int size;
        char *fmtspec;
 
-       if (opt_output_format && !strcmp(opt_output_format, "sigrok")) {
-               /* Doesn't really exist as an output module - this is
-                * the session save mode. */
-               g_free(opt_output_format);
-               opt_output_format = NULL;
-       }
-
        if (!opt_output_format) {
-               opt_output_format = DEFAULT_OUTPUT_FORMAT;
-               /* we'll need to remember this so when saving to a file
-                * later, sigrok session format will be used.
-                */
-               default_output_format = TRUE;
+               if (opt_output_file) {
+                       size = strlen(opt_output_file) + 32;
+                       srzip_and_filename = g_malloc(size);
+                       snprintf(srzip_and_filename, size, "srzip:filename=%s", opt_output_file);
+                       opt_output_format = srzip_and_filename;
+               } else {
+                       opt_output_format = DEFAULT_OUTPUT_FORMAT;
+               }
        }
 
        fmtargs = parse_generic_arg(opt_output_format, TRUE);
@@ -127,11 +100,11 @@ const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi)
        if (!fmtspec)
                g_critical("Invalid output format.");
        if (!(omod = sr_output_find(fmtspec)))
-               g_critical("Unknown output format '%s'.", fmtspec);
+               g_critical("Unknown output module '%s'.", fmtspec);
        g_hash_table_remove(fmtargs, "sigrok_key");
-       if ((opts = sr_output_options_get(omod))) {
-               fmtopts = generic_arg_to_opt(opts, fmtargs);
-               sr_output_options_free(omod);
+       if ((options = sr_output_options_get(omod))) {
+               fmtopts = generic_arg_to_opt(options, fmtargs);
+               sr_output_options_free(options);
        } else
                fmtopts = NULL;
        o = sr_output_new(omod, fmtopts, sdi);
@@ -142,6 +115,37 @@ const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi)
        return o;
 }
 
+const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi)
+{
+       const struct sr_transform_module *tmod;
+       const struct sr_option **options;
+       const struct sr_transform *t;
+       GHashTable *fmtargs, *fmtopts;
+       char *fmtspec;
+
+       if (!opt_transform_module)
+               opt_transform_module = "nop";
+
+       fmtargs = parse_generic_arg(opt_transform_module, TRUE);
+       fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
+       if (!fmtspec)
+               g_critical("Invalid transform module.");
+       if (!(tmod = sr_transform_find(fmtspec)))
+               g_critical("Unknown transform module '%s'.", fmtspec);
+       g_hash_table_remove(fmtargs, "sigrok_key");
+       if ((options = sr_transform_options_get(tmod))) {
+               fmtopts = generic_arg_to_opt(options, fmtargs);
+               sr_transform_options_free(options);
+       } else
+               fmtopts = NULL;
+       t = sr_transform_new(tmod, fmtopts, sdi);
+       if (fmtopts)
+               g_hash_table_destroy(fmtopts);
+       g_hash_table_destroy(fmtargs);
+
+       return t;
+}
+
 void datafeed_in(const struct sr_dev_inst *sdi,
                const struct sr_datafeed_packet *packet, void *cb_data)
 {
@@ -150,7 +154,6 @@ void datafeed_in(const struct sr_dev_inst *sdi,
        const struct sr_datafeed_analog *analog;
        struct sr_session *session;
        struct sr_config *src;
-       struct sr_channel *ch;
        static const struct sr_output *o = NULL;
        static const struct sr_output *oa = NULL;
        static uint64_t rcvd_samples_logic = 0;
@@ -163,11 +166,12 @@ void datafeed_in(const struct sr_dev_inst *sdi,
        GVariant *gvar;
        uint64_t end_sample;
        uint64_t input_len;
-       int i;
-       char **channels;
+       struct sr_dev_driver *driver;
+
+       driver = sr_dev_inst_driver_get(sdi);
 
        /* If the first packet to come in isn't a header, don't even try. */
-       if (packet->type != SR_DF_HEADER && o == NULL)
+       if (packet->type != SR_DF_HEADER && !o)
                return;
 
        session = cb_data;
@@ -180,20 +184,14 @@ void datafeed_in(const struct sr_dev_inst *sdi,
                /* Set up backup analog output module. */
                oa = sr_output_new(sr_output_find("analog"), NULL, sdi);
 
-               /* Prepare non-stdout output. */
-               outfile = stdout;
-               if (opt_output_file) {
-                       if (default_output_format) {
-                               outfile = NULL;
-                       } else {
-                               /* saving to a file in whatever format was set
-                                * with --format, so all we need is a filehandle */
-                               outfile = g_fopen(opt_output_file, "wb");
-                       }
-               }
+               if (opt_output_file)
+                       outfile = g_fopen(opt_output_file, "wb");
+               else
+                       outfile = stdout;
+
                rcvd_samples_logic = rcvd_samples_analog = 0;
 
-               if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE,
+               if (maybe_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
                                &gvar) == SR_OK) {
                        samplerate = g_variant_get_uint64(gvar);
                        g_variant_unref(gvar);
@@ -270,30 +268,12 @@ void datafeed_in(const struct sr_dev_inst *sdi,
                        end_sample = limit_samples;
                input_len = (end_sample - rcvd_samples_logic) * logic->unitsize;
 
-               if (opt_output_file && default_output_format) {
-                       /* Saving to a session file. */
-                       if (rcvd_samples_logic == 0) {
-                               /* First packet with logic data, init session file. */
-                               channels = g_malloc(sizeof(char *) * g_slist_length(sdi->channels));
-                               for (i = 0, l = sdi->channels; l; l = l->next) {
-                                       ch = l->data;
-                                       if (ch->enabled && ch->type == SR_CHANNEL_LOGIC)
-                                               channels[i++] = ch->name;
-                               }
-                               channels[i] = NULL;
-                               sr_session_save_init(session, opt_output_file,
-                                               samplerate, channels);
-                               g_free(channels);
-                       }
-                       save_chunk_logic(session, logic->data, input_len, logic->unitsize);
-               } else {
-                       if (opt_pds) {
+               if (opt_pds) {
 #ifdef HAVE_SRD
-                               if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
-                                               logic->data, input_len) != SRD_OK)
-                                       sr_session_stop(session);
+                       if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
+                                       logic->data, input_len) != SRD_OK)
+                               sr_session_stop(session);
 #endif
-                       }
                }
 
                rcvd_samples_logic = end_sample;
@@ -325,10 +305,13 @@ void datafeed_in(const struct sr_dev_inst *sdi,
 
        if (o && outfile && !opt_pds) {
                if (sr_output_send(o, packet, &out) == SR_OK) {
-                       if (!out || (out->len == 0 && default_output_format
+                       if (!out || (out->len == 0
+                                       && !opt_output_format
                                        && packet->type == SR_DF_ANALOG)) {
-                               /* The user didn't specify an output module,
-                                * but needs to see this analog data. */
+                               /*
+                                * The user didn't specify an output module,
+                                * but needs to see this analog data.
+                                */
                                sr_output_send(oa, packet, &out);
                        }
                        if (out && out->len > 0) {
@@ -340,13 +323,17 @@ void datafeed_in(const struct sr_dev_inst *sdi,
                }
        }
 
-       /* SR_DF_END needs to be handled after the output module's receive()
-        * is called, so it can properly clean up that module. */
+       /*
+        * SR_DF_END needs to be handled after the output module's receive()
+        * is called, so it can properly clean up that module.
+        */
        if (packet->type == SR_DF_END) {
                g_debug("cli: Received SR_DF_END.");
 
-               if (o)
+               if (o) {
                        sr_output_free(o);
+                       g_free(srzip_and_filename);
+               }
                o = NULL;
 
                sr_output_free(oa);
@@ -355,10 +342,6 @@ void datafeed_in(const struct sr_dev_inst *sdi,
                if (outfile && outfile != stdout)
                        fclose(outfile);
 
-               if (opt_output_file && default_output_format)
-                       /* Flush whatever is left out to the session file. */
-                       save_chunk_logic(session, NULL, 0, 0);
-
                if (limit_samples) {
                        if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples)
                                g_warning("Device only sent %" PRIu64 " samples.",
@@ -377,7 +360,9 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src)
        double tmp_double, dlow, dhigh;
        uint64_t tmp_u64, p, q, low, high;
        GVariant *rational[2], *range[2];
+       GVariantBuilder *vbl;
        gboolean tmp_bool;
+       gchar **keyval;
        int ret;
 
        if (!(srci = sr_config_info_name_get(key))) {
@@ -386,7 +371,7 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src)
        }
        src->key = srci->key;
 
-       if ((value == NULL) &&
+       if ((!value || strlen(value) == 0) &&
                (srci->datatype != SR_T_BOOL)) {
                g_critical("Option '%s' needs a value.", (char *)key);
                return -1;
@@ -454,10 +439,30 @@ int opt_to_gvar(char *key, char *value, struct sr_config *src)
                        src->data = g_variant_new_tuple(range, 2);
                }
                break;
+       case SR_T_KEYVALUE:
+               /* Expects the argument to be in the form of key=value. */
+               keyval = g_strsplit(value, "=", 2);
+               if (!keyval[0] || !keyval[1]) {
+                       g_strfreev(keyval);
+                       ret = -1;
+                       break;
+               } else {
+                       vbl = g_variant_builder_new(G_VARIANT_TYPE_DICTIONARY);
+                       g_variant_builder_add(vbl, "{ss}",
+                                             keyval[0], keyval[1]);
+                       src->data = g_variant_builder_end(vbl);
+                       g_strfreev(keyval);
+               }
+               break;
        default:
+               g_critical("Unknown data type specified for option '%s' "
+                          "(driver implementation bug?).", key);
                ret = -1;
        }
 
+       if (ret < 0)
+               g_critical("Invalid value: '%s' for option '%s'", value, key);
+
        return ret;
 }
 
@@ -474,9 +479,10 @@ int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
                if ((ret = opt_to_gvar(key, value, &src)) != 0)
                        return ret;
                cg = select_channel_group(sdi);
-               ret = sr_config_set(sdi, cg, src.key, src.data);
-               if (ret != SR_OK) {
-                       g_critical("Failed to set device option '%s'.", (char *)key);
+               if ((ret = maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, cg,
+                               src.key, src.data)) != SR_OK) {
+                       g_critical("Failed to set device option '%s': %s.",
+                                  (char *)key, sr_strerror(ret));
                        return ret;
                }
        }
@@ -486,28 +492,67 @@ int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
 
 void run_session(void)
 {
-       GSList *devices;
+       GSList *devices, *real_devices, *sd;
        GHashTable *devargs;
        GVariant *gvar;
        struct sr_session *session;
        struct sr_trigger *trigger;
        struct sr_dev_inst *sdi;
        uint64_t min_samples, max_samples;
+       gsize n_elements, i;
+       const uint32_t *dev_opts;
+       int is_demo_dev;
+       struct sr_dev_driver *driver;
+       const struct sr_transform *t;
 
        devices = device_scan();
        if (!devices) {
                g_critical("No devices found.");
                return;
        }
+
+       real_devices = NULL;
+       for (sd = devices; sd; sd = sd->next) {
+               sdi = sd->data;
+
+               driver = sr_dev_inst_driver_get(sdi);
+
+               if (sr_config_list(driver, sdi, NULL, SR_CONF_DEVICE_OPTIONS, &gvar) != SR_OK) {
+                       g_critical("Failed to query list device options.");
+                       return;
+               }
+
+               dev_opts = g_variant_get_fixed_array(gvar, &n_elements, sizeof(uint32_t));
+
+               is_demo_dev = 0;
+               for (i = 0; i < n_elements; i++) {
+                       if (dev_opts[i] == SR_CONF_DEMO_DEV)
+                               is_demo_dev = 1;
+               }
+
+               g_variant_unref(gvar);
+
+               if (!is_demo_dev)
+                       real_devices = g_slist_append(real_devices, sdi);
+       }
+
        if (g_slist_length(devices) > 1) {
-               g_critical("sigrok-cli only supports one device for capturing.");
-               g_slist_free(devices);
-               return;
+               if (g_slist_length(real_devices) != 1) {
+                       g_critical("sigrok-cli only supports one device for capturing.");
+                       return;
+               } else {
+                       /* We only have one non-demo device. */
+                       g_slist_free(devices);
+                       devices = real_devices;
+                       real_devices = NULL;
+               }
        }
+
        sdi = devices->data;
        g_slist_free(devices);
+       g_slist_free(real_devices);
 
-       sr_session_new(&session);
+       sr_session_new(sr_ctx, &session);
        sr_session_datafeed_callback_add(session, datafeed_in, NULL);
 
        if (sr_dev_open(sdi) != SR_OK) {
@@ -567,10 +612,12 @@ void run_session(void)
                        sr_session_destroy(session);
                        return;
                }
-               if (sr_config_list(sdi->driver, sdi, NULL,
-                               SR_CONF_LIMIT_SAMPLES, &gvar) == SR_OK) {
-                       /* The device has no compression, or compression is turned
-                        * off, and publishes its sample memory size. */
+               if (maybe_config_list(driver, sdi, NULL, SR_CONF_LIMIT_SAMPLES,
+                               &gvar) == SR_OK) {
+                       /*
+                        * The device has no compression, or compression is turned
+                        * off, and publishes its sample memory size.
+                        */
                        g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
                        g_variant_unref(gvar);
                        if (limit_samples < min_samples) {
@@ -583,7 +630,7 @@ void run_session(void)
                        }
                }
                gvar = g_variant_new_uint64(limit_samples);
-               if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
+               if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
                        g_critical("Failed to configure sample limit.");
                        sr_session_destroy(session);
                        return;
@@ -597,13 +644,16 @@ void run_session(void)
                        return;
                }
                gvar = g_variant_new_uint64(limit_frames);
-               if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
+               if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
                        g_critical("Failed to configure frame limit.");
                        sr_session_destroy(session);
                        return;
                }
        }
 
+       if (!(t = setup_transform_module(sdi)))
+               g_critical("Failed to initialize transform module.");
+
        if (sr_session_start(session) != SR_OK) {
                g_critical("Failed to start session.");
                sr_session_destroy(session);
@@ -622,40 +672,3 @@ void run_session(void)
        sr_session_destroy(session);
 
 }
-
-void save_chunk_logic(struct sr_session *session, uint8_t *data,
-               uint64_t data_len, int unitsize)
-{
-       static uint8_t *buf = NULL;
-       static int buf_len = 0;
-       static int last_unitsize = 0;
-       int max;
-
-       if (!buf)
-               buf = g_malloc(SAVE_CHUNK_SIZE);
-
-       while (data_len > SAVE_CHUNK_SIZE) {
-               save_chunk_logic(session, data, SAVE_CHUNK_SIZE, unitsize);
-               data += SAVE_CHUNK_SIZE;
-               data_len -= SAVE_CHUNK_SIZE;
-       }
-
-       if (buf_len + data_len > SAVE_CHUNK_SIZE) {
-               max = (SAVE_CHUNK_SIZE - buf_len) / unitsize * unitsize;
-               memcpy(buf + buf_len, data, max);
-               sr_session_append(session, opt_output_file, buf, unitsize,
-                               (buf_len + max) / unitsize);
-               memcpy(buf, data + max, data_len - max);
-               buf_len = data_len - max;
-       } else if (data_len == 0 && last_unitsize != 0) {
-               /* End of data, flush the buffer out. */
-               sr_session_append(session, opt_output_file, buf, last_unitsize,
-                               buf_len / last_unitsize);
-       } else {
-               /* Buffer chunk. */
-               memcpy(buf + buf_len, data, data_len);
-               buf_len += data_len;
-       }
-       last_unitsize = unitsize;
-
-}