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/>.
21 #include "libsigrok.h"
22 #include "libsigrok-internal.h"
24 #define LOG_PREFIX "output"
29 * Output module handling.
33 * @defgroup grp_output Output modules
35 * Output module handling.
37 * libsigrok supports several output modules for file formats such as binary,
38 * VCD, gnuplot, and so on. It provides an output API that frontends can use.
39 * New output modules can be added/implemented in libsigrok without having
40 * to change the frontends at all.
42 * All output modules are fed data in a stream. Devices that can stream data
43 * into libsigrok, instead of storing and then transferring the whole buffer,
44 * can thus generate output live.
46 * Output modules generate a newly allocated GString. The caller is then
47 * expected to free this with g_string_free() when finished with it.
53 extern SR_PRIV struct sr_output_module output_bits;
54 extern SR_PRIV struct sr_output_module output_hex;
55 extern SR_PRIV struct sr_output_module output_ascii;
56 extern SR_PRIV struct sr_output_module output_binary;
57 extern SR_PRIV struct sr_output_module output_vcd;
58 extern SR_PRIV struct sr_output_module output_ols;
59 extern SR_PRIV struct sr_output_module output_gnuplot;
60 extern SR_PRIV struct sr_output_module output_chronovu_la8;
61 extern SR_PRIV struct sr_output_module output_csv;
62 extern SR_PRIV struct sr_output_module output_analog;
63 extern SR_PRIV struct sr_output_module output_srzip;
64 extern SR_PRIV struct sr_output_module output_wav;
67 static const struct sr_output_module *output_module_list[] = {
84 * Returns a NULL-terminated list of all available output modules.
88 SR_API const struct sr_output_module **sr_output_list(void)
90 return output_module_list;
94 * Returns the specified output module's ID.
98 SR_API const char *sr_output_id_get(const struct sr_output_module *omod)
101 sr_err("Invalid output module NULL!");
109 * Returns the specified output module's name.
113 SR_API const char *sr_output_name_get(const struct sr_output_module *omod)
116 sr_err("Invalid output module NULL!");
124 * Returns the specified output module's description.
128 SR_API const char *sr_output_description_get(const struct sr_output_module *omod)
131 sr_err("Invalid output module NULL!");
139 * Returns the specified output module's file extensions typical for the file
140 * format, as a NULL terminated array, or returns a NULL pointer if there is
141 * no preferred extension.
142 * @note these are a suggestions only.
146 SR_API const char *const *sr_output_extensions_get(
147 const struct sr_output_module *omod)
150 sr_err("Invalid output module NULL!");
158 * Return the output module with the specified ID, or NULL if no module
159 * with that id is found.
163 SR_API const struct sr_output_module *sr_output_find(char *id)
167 for (i = 0; output_module_list[i]; i++) {
168 if (!strcmp(output_module_list[i]->id, id))
169 return output_module_list[i];
176 * Returns a NULL-terminated array of struct sr_option, or NULL if the
177 * module takes no options.
179 * Each call to this function must be followed by a call to
180 * sr_output_options_free().
184 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod)
186 const struct sr_option *mod_opts, **opts;
189 if (!omod || !omod->options)
192 mod_opts = omod->options();
194 for (size = 0; mod_opts[size].id; size++)
196 opts = g_malloc((size + 1) * sizeof(struct sr_option *));
198 for (i = 0; i < size; i++)
199 opts[i] = &mod_opts[i];
206 * After a call to sr_output_options_get(), this function cleans up all
207 * resources returned by that call.
211 SR_API void sr_output_options_free(const struct sr_option **options)
218 for (i = 0; options[i]; i++) {
219 if (options[i]->def) {
220 g_variant_unref(options[i]->def);
221 ((struct sr_option *)options[i])->def = NULL;
224 if (options[i]->values) {
225 g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
226 ((struct sr_option *)options[i])->values = NULL;
233 * Create a new output instance using the specified output module.
235 * <code>options</code> is a *HashTable with the keys corresponding with
236 * the module options' <code>id</code> field. The values should be GVariant
237 * pointers with sunk * references, of the same GVariantType as the option's
240 * The sr_dev_inst passed in can be used by the instance to determine
241 * channel names, samplerate, and so on.
245 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
246 GHashTable *options, const struct sr_dev_inst *sdi)
248 struct sr_output *op;
249 const struct sr_option *mod_opts;
250 const GVariantType *gvt;
251 GHashTable *new_opts;
256 op = g_malloc(sizeof(struct sr_output));
260 new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
261 (GDestroyNotify)g_variant_unref);
263 mod_opts = omod->options();
264 for (i = 0; mod_opts[i].id; i++) {
265 if (options && g_hash_table_lookup_extended(options,
266 mod_opts[i].id, &key, &value)) {
267 /* Pass option along. */
268 gvt = g_variant_get_type(mod_opts[i].def);
269 if (!g_variant_is_of_type(value, gvt)) {
270 sr_err("Invalid type for '%s' option.", key);
274 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
275 g_variant_ref(value));
277 /* Option not given: insert the default value. */
278 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
279 g_variant_ref(mod_opts[i].def));
283 /* Make sure no invalid options were given. */
285 g_hash_table_iter_init(&iter, options);
286 while (g_hash_table_iter_next(&iter, &key, &value)) {
287 if (!g_hash_table_lookup(new_opts, key)) {
288 sr_err("Output module '%s' has no option '%s'", omod->id, key);
289 g_hash_table_destroy(new_opts);
297 if (op->module->init && op->module->init(op, new_opts) != SR_OK) {
302 g_hash_table_destroy(new_opts);
308 * Send a packet to the specified output instance.
310 * The instance's output is returned as a newly allocated GString,
311 * which must be freed by the caller.
315 SR_API int sr_output_send(const struct sr_output *o,
316 const struct sr_datafeed_packet *packet, GString **out)
318 return o->module->receive(o, packet, out);
322 * Free the specified output instance and all associated resources.
326 SR_API int sr_output_free(const struct sr_output *o)
334 if (o->module->cleanup)
335 ret = o->module->cleanup((struct sr_output *)o);