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"
25 #define LOG_PREFIX "output"
31 * Output module handling.
35 * @defgroup grp_output Output modules
37 * Output module handling.
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.
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.
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.
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;
69 static const struct sr_output_module *output_module_list[] = {
86 * Returns a NULL-terminated list of all available output modules.
90 SR_API const struct sr_output_module **sr_output_list(void)
92 return output_module_list;
96 * Returns the specified output module's ID.
100 SR_API const char *sr_output_id_get(const struct sr_output_module *omod)
103 sr_err("Invalid output module NULL!");
111 * Returns the specified output module's name.
115 SR_API const char *sr_output_name_get(const struct sr_output_module *omod)
118 sr_err("Invalid output module NULL!");
126 * Returns the specified output module's description.
130 SR_API const char *sr_output_description_get(const struct sr_output_module *omod)
133 sr_err("Invalid output module NULL!");
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.
148 SR_API const char *const *sr_output_extensions_get(
149 const struct sr_output_module *omod)
152 sr_err("Invalid output module NULL!");
160 * Return the output module with the specified ID, or NULL if no module
161 * with that id is found.
165 SR_API const struct sr_output_module *sr_output_find(char *id)
169 for (i = 0; output_module_list[i]; i++) {
170 if (!strcmp(output_module_list[i]->id, id))
171 return output_module_list[i];
178 * Returns a NULL-terminated array of struct sr_option, or NULL if the
179 * module takes no options.
181 * Each call to this function must be followed by a call to
182 * sr_output_options_free().
186 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod)
188 const struct sr_option *mod_opts, **opts;
191 if (!omod || !omod->options)
194 mod_opts = omod->options();
196 for (size = 0; mod_opts[size].id; size++)
198 opts = g_malloc((size + 1) * sizeof(struct sr_option *));
200 for (i = 0; i < size; i++)
201 opts[i] = &mod_opts[i];
208 * After a call to sr_output_options_get(), this function cleans up all
209 * resources returned by that call.
213 SR_API void sr_output_options_free(const struct sr_option **options)
220 for (i = 0; options[i]; i++) {
221 if (options[i]->def) {
222 g_variant_unref(options[i]->def);
223 ((struct sr_option *)options[i])->def = NULL;
226 if (options[i]->values) {
227 g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
228 ((struct sr_option *)options[i])->values = NULL;
235 * Create a new output instance using the specified output module.
237 * <code>options</code> is a *HashTable with the keys corresponding with
238 * the module options' <code>id</code> field. The values should be GVariant
239 * pointers with sunk * references, of the same GVariantType as the option's
242 * The sr_dev_inst passed in can be used by the instance to determine
243 * channel names, samplerate, and so on.
247 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
248 GHashTable *options, const struct sr_dev_inst *sdi)
250 struct sr_output *op;
251 const struct sr_option *mod_opts;
252 const GVariantType *gvt;
253 GHashTable *new_opts;
258 op = g_malloc(sizeof(struct sr_output));
262 new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
263 (GDestroyNotify)g_variant_unref);
265 mod_opts = omod->options();
266 for (i = 0; mod_opts[i].id; i++) {
267 if (options && g_hash_table_lookup_extended(options,
268 mod_opts[i].id, &key, &value)) {
269 /* Pass option along. */
270 gvt = g_variant_get_type(mod_opts[i].def);
271 if (!g_variant_is_of_type(value, gvt)) {
272 sr_err("Invalid type for '%s' option.", key);
276 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
277 g_variant_ref(value));
279 /* Option not given: insert the default value. */
280 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
281 g_variant_ref(mod_opts[i].def));
285 /* Make sure no invalid options were given. */
287 g_hash_table_iter_init(&iter, options);
288 while (g_hash_table_iter_next(&iter, &key, &value)) {
289 if (!g_hash_table_lookup(new_opts, key)) {
290 sr_err("Output module '%s' has no option '%s'", omod->id, key);
291 g_hash_table_destroy(new_opts);
299 if (op->module->init && op->module->init(op, new_opts) != SR_OK) {
304 g_hash_table_destroy(new_opts);
310 * Send a packet to the specified output instance.
312 * The instance's output is returned as a newly allocated GString,
313 * which must be freed by the caller.
317 SR_API int sr_output_send(const struct sr_output *o,
318 const struct sr_datafeed_packet *packet, GString **out)
320 return o->module->receive(o, packet, out);
324 * Free the specified output instance and all associated resources.
328 SR_API int sr_output_free(const struct sr_output *o)
336 if (o->module->cleanup)
337 ret = o->module->cleanup((struct sr_output *)o);