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