src/output/output.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
   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
  20 #include <config.h>
  21 #include <string.h>
  22 #include <libsigrok/libsigrok.h>
  23 #include "libsigrok-internal.h"
  24
  25 /** @cond PRIVATE */
  26 #define LOG_PREFIX "output"
  27 /** @endcond */
  28
  29 /**
  30  * @file
  31  *
  32  * Output module handling.
  33  */
  34
  35 /**
  36  * @defgroup grp_output Output modules
  37  *
  38  * Output module handling.
  39  *
  40  * libsigrok supports several output modules for file formats such as binary,
  41  * VCD, csv, and so on. It provides an output API that frontends can use.
  42  * New output modules can be added/implemented in libsigrok without having
  43  * to change the frontends at all.
  44  *
  45  * All output modules are fed data in a stream. Devices that can stream data
  46  * into libsigrok, instead of storing and then transferring the whole buffer,
  47  * can thus generate output live.
  48  *
  49  * Output modules generate a newly allocated GString. The caller is then
  50  * expected to free this with g_string_free() when finished with it.
  51  *
  52  * @{
  53  */
  54
  55 /** @cond PRIVATE */
  56 extern SR_PRIV struct sr_output_module output_bits;
  57 extern SR_PRIV struct sr_output_module output_hex;
  58 extern SR_PRIV struct sr_output_module output_ascii;
  59 extern SR_PRIV struct sr_output_module output_binary;
  60 extern SR_PRIV struct sr_output_module output_vcd;
  61 extern SR_PRIV struct sr_output_module output_ols;
  62 extern SR_PRIV struct sr_output_module output_chronovu_la8;
  63 extern SR_PRIV struct sr_output_module output_csv;
  64 extern SR_PRIV struct sr_output_module output_analog;
  65 extern SR_PRIV struct sr_output_module output_srzip;
  66 extern SR_PRIV struct sr_output_module output_wav;
  67 extern SR_PRIV struct sr_output_module output_null;
  68 /* @endcond */
  69
  70 static const struct sr_output_module *output_module_list[] = {
  71         &output_ascii,
  72         &output_binary,
  73         &output_bits,
  74         &output_csv,
  75         &output_hex,
  76         &output_ols,
  77         &output_vcd,
  78         &output_chronovu_la8,
  79         &output_analog,
  80         &output_srzip,
  81         &output_wav,
  82         &output_null,
  83         NULL,
  84 };
  85
  86 /**
  87  * Returns a NULL-terminated list of all available output modules.
  88  *
  89  * @since 0.4.0
  90  */
  91 SR_API const struct sr_output_module **sr_output_list(void)
  92 {
  93         return output_module_list;
  94 }
  95
  96 /**
  97  * Returns the specified output module's ID.
  98  *
  99  * @since 0.4.0
 100  */
 101 SR_API const char *sr_output_id_get(const struct sr_output_module *omod)
 102 {
 103         if (!omod) {
 104                 sr_err("Invalid output module NULL!");
 105                 return NULL;
 106         }
 107
 108         return omod->id;
 109 }
 110
 111 /**
 112  * Returns the specified output module's name.
 113  *
 114  * @since 0.4.0
 115  */
 116 SR_API const char *sr_output_name_get(const struct sr_output_module *omod)
 117 {
 118         if (!omod) {
 119                 sr_err("Invalid output module NULL!");
 120                 return NULL;
 121         }
 122
 123         return omod->name;
 124 }
 125
 126 /**
 127  * Returns the specified output module's description.
 128  *
 129  * @since 0.4.0
 130  */
 131 SR_API const char *sr_output_description_get(const struct sr_output_module *omod)
 132 {
 133         if (!omod) {
 134                 sr_err("Invalid output module NULL!");
 135                 return NULL;
 136         }
 137
 138         return omod->desc;
 139 }
 140
 141 /**
 142  * Returns the specified output module's file extensions typical for the file
 143  * format, as a NULL terminated array, or returns a NULL pointer if there is
 144  * no preferred extension.
 145  * @note these are a suggestions only.
 146  *
 147  * @since 0.4.0
 148  */
 149 SR_API const char *const *sr_output_extensions_get(
 150                 const struct sr_output_module *omod)
 151 {
 152         if (!omod) {
 153                 sr_err("Invalid output module NULL!");
 154                 return NULL;
 155         }
 156
 157         return omod->exts;
 158 }
 159
 160 /*
 161  * Checks whether a given flag is set.
 162  *
 163  * @see sr_output_flag
 164  * @since 0.4.0
 165  */
 166 SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
 167                 uint64_t flag)
 168 {
 169         return (flag & omod->flags);
 170 }
 171
 172 /**
 173  * Return the output module with the specified ID, or NULL if no module
 174  * with that id is found.
 175  *
 176  * @since 0.4.0
 177  */
 178 SR_API const struct sr_output_module *sr_output_find(char *id)
 179 {
 180         int i;
 181
 182         for (i = 0; output_module_list[i]; i++) {
 183                 if (!strcmp(output_module_list[i]->id, id))
 184                         return output_module_list[i];
 185         }
 186
 187         return NULL;
 188 }
 189
 190 /**
 191  * Returns a NULL-terminated array of struct sr_option, or NULL if the
 192  * module takes no options.
 193  *
 194  * Each call to this function must be followed by a call to
 195  * sr_output_options_free().
 196  *
 197  * @since 0.4.0
 198  */
 199 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod)
 200 {
 201         const struct sr_option *mod_opts, **opts;
 202         int size, i;
 203
 204         if (!omod || !omod->options)
 205                 return NULL;
 206
 207         mod_opts = omod->options();
 208
 209         for (size = 0; mod_opts[size].id; size++)
 210                 ;
 211         opts = g_malloc((size + 1) * sizeof(struct sr_option *));
 212
 213         for (i = 0; i < size; i++)
 214                 opts[i] = &mod_opts[i];
 215         opts[i] = NULL;
 216
 217         return opts;
 218 }
 219
 220 /**
 221  * After a call to sr_output_options_get(), this function cleans up all
 222  * resources returned by that call.
 223  *
 224  * @since 0.4.0
 225  */
 226 SR_API void sr_output_options_free(const struct sr_option **options)
 227 {
 228         int i;
 229
 230         if (!options)
 231                 return;
 232
 233         for (i = 0; options[i]; i++) {
 234                 if (options[i]->def) {
 235                         g_variant_unref(options[i]->def);
 236                         ((struct sr_option *)options[i])->def = NULL;
 237                 }
 238
 239                 if (options[i]->values) {
 240                         g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
 241                         ((struct sr_option *)options[i])->values = NULL;
 242                 }
 243         }
 244         g_free(options);
 245 }
 246
 247 /**
 248  * Create a new output instance using the specified output module.
 249  *
 250  * <code>options</code> is a *HashTable with the keys corresponding with
 251  * the module options' <code>id</code> field. The values should be GVariant
 252  * pointers with sunk * references, of the same GVariantType as the option's
 253  * default value.
 254  *
 255  * The sr_dev_inst passed in can be used by the instance to determine
 256  * channel names, samplerate, and so on.
 257  *
 258  * @since 0.4.0
 259  */
 260 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
 261                 GHashTable *options, const struct sr_dev_inst *sdi,
 262                 const char *filename)
 263 {
 264         struct sr_output *op;
 265         const struct sr_option *mod_opts;
 266         const GVariantType *gvt;
 267         GHashTable *new_opts;
 268         GHashTableIter iter;
 269         gpointer key, value;
 270         int i;
 271
 272         op = g_malloc(sizeof(struct sr_output));
 273         op->module = omod;
 274         op->sdi = sdi;
 275         op->filename = g_strdup(filename);
 276
 277         new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
 278                         (GDestroyNotify)g_variant_unref);
 279         if (omod->options) {
 280                 mod_opts = omod->options();
 281                 for (i = 0; mod_opts[i].id; i++) {
 282                         if (options && g_hash_table_lookup_extended(options,
 283                                         mod_opts[i].id, &key, &value)) {
 284                                 /* Pass option along. */
 285                                 gvt = g_variant_get_type(mod_opts[i].def);
 286                                 if (!g_variant_is_of_type(value, gvt)) {
 287                                         sr_err("Invalid type for '%s' option.",
 288                                                 (char *)key);
 289                                         g_free(op);
 290                                         return NULL;
 291                                 }
 292                                 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
 293                                                 g_variant_ref(value));
 294                         } else {
 295                                 /* Option not given: insert the default value. */
 296                                 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
 297                                                 g_variant_ref(mod_opts[i].def));
 298                         }
 299                 }
 300
 301                 /* Make sure no invalid options were given. */
 302                 if (options) {
 303                         g_hash_table_iter_init(&iter, options);
 304                         while (g_hash_table_iter_next(&iter, &key, &value)) {
 305                                 if (!g_hash_table_lookup(new_opts, key)) {
 306                                         sr_err("Output module '%s' has no option '%s'",
 307                                                 omod->id, (char *)key);
 308                                         g_hash_table_destroy(new_opts);
 309                                         g_free(op);
 310                                         return NULL;
 311                                 }
 312                         }
 313                 }
 314         }
 315
 316         if (op->module->init && op->module->init(op, new_opts) != SR_OK) {
 317                 g_free(op);
 318                 op = NULL;
 319         }
 320         if (new_opts)
 321                 g_hash_table_destroy(new_opts);
 322
 323         return op;
 324 }
 325
 326 /**
 327  * Send a packet to the specified output instance.
 328  *
 329  * The instance's output is returned as a newly allocated GString,
 330  * which must be freed by the caller.
 331  *
 332  * @since 0.4.0
 333  */
 334 SR_API int sr_output_send(const struct sr_output *o,
 335                 const struct sr_datafeed_packet *packet, GString **out)
 336 {
 337         return o->module->receive(o, packet, out);
 338 }
 339
 340 /**
 341  * Free the specified output instance and all associated resources.
 342  *
 343  * @since 0.4.0
 344  */
 345 SR_API int sr_output_free(const struct sr_output *o)
 346 {
 347         int ret;
 348
 349         if (!o)
 350                 return SR_ERR_ARG;
 351
 352         ret = SR_OK;
 353         if (o->module->cleanup)
 354                 ret = o->module->cleanup((struct sr_output *)o);
 355         g_free((char *)o->filename);
 356         g_free((gpointer)o);
 357
 358         return ret;
 359 }
 360
 361 /** @} */