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/>.
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
27 #define LOG_PREFIX "transform"
33 * Transform module handling.
37 * @defgroup grp_transform Transform modules
39 * Transform module handling.
45 extern SR_PRIV struct sr_transform_module transform_nop;
46 extern SR_PRIV struct sr_transform_module transform_scale;
47 extern SR_PRIV struct sr_transform_module transform_invert;
50 static const struct sr_transform_module *transform_module_list[] = {
58 * Returns a NULL-terminated list of all available transform modules.
62 SR_API const struct sr_transform_module **sr_transform_list(void)
64 return transform_module_list;
68 * Returns the specified transform module's ID.
72 SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod)
75 sr_err("Invalid transform module NULL!");
83 * Returns the specified transform module's name.
87 SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod)
90 sr_err("Invalid transform module NULL!");
98 * Returns the specified transform module's description.
102 SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod)
105 sr_err("Invalid transform module NULL!");
113 * Return the transform module with the specified ID, or NULL if no module
114 * with that ID is found.
118 SR_API const struct sr_transform_module *sr_transform_find(const char *id)
122 for (i = 0; transform_module_list[i]; i++) {
123 if (!strcmp(transform_module_list[i]->id, id))
124 return transform_module_list[i];
131 * Returns a NULL-terminated array of struct sr_option, or NULL if the
132 * module takes no options.
134 * Each call to this function must be followed by a call to
135 * sr_transform_options_free().
139 SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod)
141 const struct sr_option *mod_opts, **opts;
144 if (!tmod || !tmod->options)
147 mod_opts = tmod->options();
149 for (size = 0; mod_opts[size].id; size++)
151 opts = g_malloc((size + 1) * sizeof(struct sr_option *));
153 for (i = 0; i < size; i++)
154 opts[i] = &mod_opts[i];
161 * After a call to sr_transform_options_get(), this function cleans up all
162 * resources returned by that call.
166 SR_API void sr_transform_options_free(const struct sr_option **options)
173 for (i = 0; options[i]; i++) {
174 if (options[i]->def) {
175 g_variant_unref(options[i]->def);
176 ((struct sr_option *)options[i])->def = NULL;
179 if (options[i]->values) {
180 g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
181 ((struct sr_option *)options[i])->values = NULL;
188 * Create a new transform instance using the specified transform module.
190 * <code>options</code> is a *GHashTable with the keys corresponding with
191 * the module options' <code>id</code> field. The values should be GVariant
192 * pointers with sunk * references, of the same GVariantType as the option's
195 * The sr_dev_inst passed in can be used by the instance to determine
196 * channel names, samplerate, and so on.
200 SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
201 GHashTable *options, const struct sr_dev_inst *sdi)
203 struct sr_transform *t;
204 const struct sr_option *mod_opts;
205 const GVariantType *gvt;
206 GHashTable *new_opts;
211 t = g_malloc(sizeof(struct sr_transform));
215 new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
216 (GDestroyNotify)g_variant_unref);
218 mod_opts = tmod->options();
219 for (i = 0; mod_opts[i].id; i++) {
220 if (options && g_hash_table_lookup_extended(options,
221 mod_opts[i].id, &key, &value)) {
222 /* Pass option along. */
223 gvt = g_variant_get_type(mod_opts[i].def);
224 if (!g_variant_is_of_type(value, gvt)) {
225 sr_err("Invalid type for '%s' option.",
230 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
231 g_variant_ref(value));
233 /* Option not given: insert the default value. */
234 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
235 g_variant_ref(mod_opts[i].def));
239 /* Make sure no invalid options were given. */
241 g_hash_table_iter_init(&iter, options);
242 while (g_hash_table_iter_next(&iter, &key, &value)) {
243 if (!g_hash_table_lookup(new_opts, key)) {
244 sr_err("Transform module '%s' has no option '%s'.",
245 tmod->id, (char *)key);
246 g_hash_table_destroy(new_opts);
254 if (t->module->init && t->module->init(t, new_opts) != SR_OK) {
259 g_hash_table_destroy(new_opts);
261 /* Add the transform to the session's list of transforms. */
262 sdi->session->transforms = g_slist_append(sdi->session->transforms, t);
268 * Free the specified transform instance and all associated resources.
272 SR_API int sr_transform_free(const struct sr_transform *t)
280 if (t->module->cleanup)
281 ret = t->module->cleanup((struct sr_transform *)t);