2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2015 Uwe Hermann <uwe@hermann-uwe.de>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "libsigrok.h"
23 #include "libsigrok-internal.h"
25 #define LOG_PREFIX "transform"
30 * Transform module handling.
34 * @defgroup grp_transform Transform modules
36 * Transform module handling.
44 static const struct sr_transform_module *transform_module_list[] = {
49 * Returns a NULL-terminated list of all available transform modules.
53 SR_API const struct sr_transform_module **sr_transform_list(void)
55 return transform_module_list;
59 * Returns the specified transform module's ID.
63 SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod)
66 sr_err("Invalid transform module NULL!");
74 * Returns the specified transform module's name.
78 SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod)
81 sr_err("Invalid transform module NULL!");
89 * Returns the specified transform module's description.
93 SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod)
96 sr_err("Invalid transform module NULL!");
104 * Return the transform module with the specified ID, or NULL if no module
105 * with that ID is found.
109 SR_API const struct sr_transform_module *sr_transform_find(const char *id)
113 for (i = 0; transform_module_list[i]; i++) {
114 if (!strcmp(transform_module_list[i]->id, id))
115 return transform_module_list[i];
122 * Returns a NULL-terminated array of struct sr_option, or NULL if the
123 * module takes no options.
125 * Each call to this function must be followed by a call to
126 * sr_transform_options_free().
130 SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod)
132 const struct sr_option *mod_opts, **opts;
135 if (!tmod || !tmod->options)
138 mod_opts = tmod->options();
140 for (size = 0; mod_opts[size].id; size++)
142 opts = g_malloc((size + 1) * sizeof(struct sr_option *));
144 for (i = 0; i < size; i++)
145 opts[i] = &mod_opts[i];
152 * After a call to sr_transform_options_get(), this function cleans up all
153 * resources returned by that call.
157 SR_API void sr_transform_options_free(const struct sr_option **options)
164 for (i = 0; options[i]; i++) {
165 if (options[i]->def) {
166 g_variant_unref(options[i]->def);
167 ((struct sr_option *)options[i])->def = NULL;
170 if (options[i]->values) {
171 g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
172 ((struct sr_option *)options[i])->values = NULL;
179 * Create a new transform instance using the specified transform module.
181 * <code>options</code> is a *GHashTable with the keys corresponding with
182 * the module options' <code>id</code> field. The values should be GVariant
183 * pointers with sunk * references, of the same GVariantType as the option's
186 * The sr_dev_inst passed in can be used by the instance to determine
187 * channel names, samplerate, and so on.
191 SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
192 GHashTable *options, const struct sr_dev_inst *sdi)
194 struct sr_transform *t;
195 const struct sr_option *mod_opts;
196 const GVariantType *gvt;
197 GHashTable *new_opts;
202 t = g_malloc(sizeof(struct sr_transform));
206 new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
207 (GDestroyNotify)g_variant_unref);
209 mod_opts = tmod->options();
210 for (i = 0; mod_opts[i].id; i++) {
211 if (options && g_hash_table_lookup_extended(options,
212 mod_opts[i].id, &key, &value)) {
213 /* Pass option along. */
214 gvt = g_variant_get_type(mod_opts[i].def);
215 if (!g_variant_is_of_type(value, gvt)) {
216 sr_err("Invalid type for '%s' option.", key);
220 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
221 g_variant_ref(value));
223 /* Option not given: insert the default value. */
224 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
225 g_variant_ref(mod_opts[i].def));
229 /* Make sure no invalid options were given. */
231 g_hash_table_iter_init(&iter, options);
232 while (g_hash_table_iter_next(&iter, &key, &value)) {
233 if (!g_hash_table_lookup(new_opts, key)) {
234 sr_err("Transform module '%s' has no option '%s'.", tmod->id, key);
235 g_hash_table_destroy(new_opts);
243 if (t->module->init && t->module->init(t, new_opts) != SR_OK) {
248 g_hash_table_destroy(new_opts);
254 * Free the specified transform instance and all associated resources.
258 SR_API int sr_transform_free(const struct sr_transform *t)
266 if (t->module->cleanup)
267 ret = t->module->cleanup((struct sr_transform *)t);