input: Fix up API documentation.

[libsigrok.git] / src / input / input.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

#define LOG_PREFIX "input"

/**
 * @file
 *
 * Input module handling.
 */

/**
 * @defgroup grp_input Input modules
 *
 * Input file/data module handling.
 *
 * libsigrok can process acquisition data in several different ways.
 * Aside from acquiring data from a hardware device, it can also take it
 * from a file in various formats (binary, CSV, VCD, and so on).
 *
 * Like all libsigrok data handling, processing is done in a streaming
 * manner: input should be supplied a chunk at a time. This way anything
 * that processes data can do so in real time, without the user having
 * to wait for the whole thing to be finished.
 *
 * Every input module is "pluggable", meaning it's handled as being separate
 * from the main libsigrok, but linked in to it statically. To keep things
 * modular and separate like this, functions within an input module should be
 * declared static, with only the respective 'struct sr_input_module' being
 * exported for use into the wider libsigrok namespace.
 *
 * @{
 */

/** @cond PRIVATE */
extern SR_PRIV struct sr_input_module input_chronovu_la8;
extern SR_PRIV struct sr_input_module input_csv;
extern SR_PRIV struct sr_input_module input_binary;
extern SR_PRIV struct sr_input_module input_vcd;
extern SR_PRIV struct sr_input_module input_wav;
/* @endcond */

static const struct sr_input_module *input_module_list[] = {
//	&input_vcd,
//	&input_chronovu_la8,
	&input_wav,
//	&input_csv,
	/* This one has to be last, because it will take any input. */
//	&input_binary,
	NULL,
};

/**
 * Returns a NULL-terminated list of all available input modules.
 *
 * @since 0.4.0
 */
SR_API const struct sr_input_module **sr_input_list(void)
{
	return input_module_list;
}

/**
 * Returns the specified input module's ID.
 *
 * @since 0.4.0
 */
SR_API const char *sr_input_id_get(const struct sr_input_module *o)
{
	if (!o) {
		sr_err("Invalid input module NULL!");
		return NULL;
	}

	return o->id;
}

/**
 * Returns the specified input module's name.
 *
 * @since 0.4.0
 */
SR_API const char *sr_input_name_get(const struct sr_input_module *o)
{
	if (!o) {
		sr_err("Invalid input module NULL!");
		return NULL;
	}

	return o->name;
}

/**
 * Returns the specified input module's description.
 *
 * @since 0.4.0
 */
SR_API const char *sr_input_description_get(const struct sr_input_module *o)
{
	if (!o) {
		sr_err("Invalid input module NULL!");
		return NULL;
	}

	return o->desc;
}

/**
 * Return the input module with the specified ID, or NULL if no module
 * with that id is found.
 *
 * @since 0.4.0
 */
SR_API const struct sr_input_module *sr_input_find(char *id)
{
	int i;

	for (i = 0; input_module_list[i]; i++) {
		if (!strcmp(input_module_list[i]->id, id))
			return input_module_list[i];
	}

	return NULL;
}

/**
 * Returns a NULL-terminated array of struct sr_option, or NULL if the
 * module takes no options.
 *
 * Each call to this function must be followed by a call to
 * sr_input_options_free().
 *
 * @since 0.4.0
 */
SR_API const struct sr_option *sr_input_options_get(const struct sr_input_module *o)
{

	if (!o || !o->options)
		return NULL;

	return o->options();
}

/**
 * After a call to sr_input_options_get(), this function cleans up all
 * resources allocated by that call.
 *
 * @since 0.4.0
 */
SR_API void sr_input_options_free(const struct sr_input_module *o)
{
	struct sr_option *opt;

	if (!o || !o->options)
		return;

	for (opt = o->options(); opt->id; opt++) {
		if (opt->def) {
			g_variant_unref(opt->def);
			opt->def = NULL;
		}

		if (opt->values) {
			g_slist_free_full(opt->values, (GDestroyNotify)g_variant_unref);
			opt->values = NULL;
		}
	}
}

/**
 * Create a new input instance using the specified input module.
 *
 * This function is used when a client wants to use a specific input
 * module to parse a stream. No effort is made to identify the format.
 *
 * @param options GHashTable consisting of keys corresponding with
 * the module options \c id field. The values should be GVariant
 * pointers with sunk references, of the same GVariantType as the option's
 * default value.
 *
 * @since 0.4.0
 */
SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
		GHashTable *options)
{
	struct sr_input *in;
	struct sr_option *mod_opts;
	const GVariantType *gvt;
	GHashTable *new_opts;
	GHashTableIter iter;
	gpointer key, value;
	int i;

	in = g_malloc0(sizeof(struct sr_input));
	in->module = imod;

	if (options) {
		new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
				(GDestroyNotify)g_variant_unref);
		mod_opts = imod->options();
		for (i = 0; mod_opts[i].id; i++) {
			if (g_hash_table_lookup_extended(options, mod_opts[i].id,
					&key, &value)) {
				/* Option not given: insert the default value. */
				gvt = g_variant_get_type(mod_opts[i].def);
				if (!g_variant_is_of_type(value, gvt)) {
					sr_err("Invalid type for '%s' option.", key);
					g_free(in);
					return NULL;
				}
				g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
						g_variant_ref(value));
			} else {
				/* Pass option along. */
				g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
						g_variant_ref(mod_opts[i].def));
			}
		}

		/* Make sure no invalid options were given. */
		g_hash_table_iter_init(&iter, options);
		while (g_hash_table_iter_next(&iter, &key, &value)) {
			if (!g_hash_table_lookup(new_opts, key)) {
				sr_err("Input module '%s' has no option '%s'", imod->id, key);
				g_hash_table_destroy(new_opts);
				g_free(in);
				return NULL;
			}
		}
	} else
		new_opts = NULL;

	if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
		g_hash_table_destroy(new_opts);
		g_free(in);
		in = NULL;
	}
	if (new_opts)
		g_hash_table_destroy(new_opts);

	return in;
}

/* Returns TRUE is all required meta items are available. */
static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
{
	int m, a;
	uint8_t reqd;

	for (m = 0; metadata[m]; m++) {
		if (!metadata[m] & SR_INPUT_META_REQUIRED)
			continue;
		reqd = metadata[m] & ~SR_INPUT_META_REQUIRED;
		for (a = 0; avail[a]; a++) {
			if (avail[a] == reqd)
				break;
		}
		if (!avail[a])
			/* Found a required meta item that isn't available. */
			return FALSE;
	}

	return TRUE;
}

/**
 * Try to find an input module that can parse the given buffer.
 *
 * The buffer must contain enough of the beginning of the file for
 * the input modules to find a match. This is format-dependent, but
 * 128 bytes is normally enough.
 *
 * If an input module is found, an instance is created and returned.
 * Otherwise, NULL is returned.
 *
 */
SR_API const struct sr_input *sr_input_scan_buffer(GString *buf)
{
	struct sr_input *in;
	const struct sr_input_module *imod;
	GHashTable *meta;
	unsigned int m, i;
	uint8_t mitem, avail_metadata[8];

	/* No more metadata to be had from a buffer. */
	avail_metadata[0] = SR_INPUT_META_HEADER;
	avail_metadata[1] = 0;

	in = NULL;
	for (i = 0; input_module_list[i]; i++) {
		imod = input_module_list[i];
		if (!imod->metadata[0]) {
			/* Module has no metadata for matching so will take
			 * any input. No point in letting it try to match. */
			continue;
		}
		if (!check_required_metadata(imod->metadata, avail_metadata))
			/* Cannot satisfy this module's requirements. */
			continue;

		meta = g_hash_table_new(NULL, NULL);
		for (m = 0; m < sizeof(imod->metadata); m++) {
			mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
			if (mitem == SR_INPUT_META_HEADER)
				g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
		}
		if (g_hash_table_size(meta) == 0) {
			/* No metadata for this module, so nothing to match. */
			g_hash_table_destroy(meta);
			continue;
		}
		if (!imod->format_match(meta)) {
			/* Module didn't recognize this buffer. */
			g_hash_table_destroy(meta);
			continue;
		}
		g_hash_table_destroy(meta);

		/* Found a matching module. */
		in = sr_input_new(imod, NULL);
		in->buf = g_string_new_len(buf->str, buf->len);
		break;
	}

	return in;
}

/**
 * Try to find an input module that can parse the given file.
 *
 * If an input module is found, an instance is created and returned.
 * Otherwise, NULL is returned.
 *
 */
SR_API const struct sr_input *sr_input_scan_file(const char *filename)
{
	struct sr_input *in;
	const struct sr_input_module *imod;
	GHashTable *meta;
	GString *buf;
	struct stat st;
	unsigned int midx, m, i;
	int fd;
	ssize_t size;
	uint8_t mitem, avail_metadata[8];

	if (!filename || !filename[0]) {
		sr_err("Invalid filename.");
		return NULL;
	}

	if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {
		sr_err("No such file.");
		return NULL;
	}

	if (stat(filename, &st) < 0) {
		sr_err("%s", strerror(errno));
		return NULL;
	}

	midx = 0;
	avail_metadata[midx++] = SR_INPUT_META_FILENAME;
	avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
	avail_metadata[midx++] = SR_INPUT_META_HEADER;
	/* TODO: MIME type */

	in = NULL;
	buf = NULL;
	for (i = 0; input_module_list[i]; i++) {
		imod = input_module_list[i];
		if (!imod->metadata[0]) {
			/* Module has no metadata for matching so will take
			 * any input. No point in letting it try to match. */
			continue;
		}
		if (!check_required_metadata(imod->metadata, avail_metadata))
			/* Cannot satisfy this module's requirements. */
			continue;

		meta = g_hash_table_new(NULL, NULL);
		for (m = 0; m < sizeof(imod->metadata); m++) {
			mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
			if (mitem == SR_INPUT_META_FILENAME)
				g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
						(gpointer)filename);
			else if (mitem == SR_INPUT_META_FILESIZE)
				g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
						GINT_TO_POINTER(st.st_size));
			else if (mitem == SR_INPUT_META_HEADER) {
				buf = g_string_sized_new(128);
				if ((fd = open(filename, O_RDONLY)) < 0) {
					sr_err("%s", strerror(errno));
					return NULL;
				}
				size = read(fd, buf->str, 128);
				buf->len = size;
				close(fd);
				if (size <= 0) {
					g_string_free(buf, TRUE);
					sr_err("%s", strerror(errno));
					return NULL;
				}
				g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
				g_string_free(buf, TRUE);
			}
		}
		if (g_hash_table_size(meta) == 0) {
			/* No metadata for this module, so there's no way it
			 * can match. */
			g_hash_table_destroy(meta);
			continue;
		}
		if (!imod->format_match(meta))
			/* Module didn't recognize this buffer. */
			continue;

		/* Found a matching module. */
		in = sr_input_new(imod, NULL);
		in->buf = g_string_new_len(buf->str, buf->len);
		break;
	}
	if (!in && buf)
		g_string_free(buf, TRUE);

	return in;
}

/**
 * Return the input instance's (virtual) device instance. This can be
 * used to find out the number of channels and other information.
 *
 * @since 0.4.0
 */
SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
{
	return in->sdi;
}

/**
 * Send data to the specified input instance.
 *
 * When an input module instance is created with sr_input_new(), this
 * function is used to feed data to the instance.
 *
 * @since 0.4.0
 */
SR_API int sr_input_send(const struct sr_input *in, GString *buf)
{
	return in->module->receive(in, buf);
}

/**
 * Free the specified input instance and all associated resources.
 *
 * @since 0.4.0
 */
SR_API int sr_input_free(const struct sr_input *in)
{
	int ret;

	if (!in)
		return SR_ERR_ARG;

	ret = SR_OK;
	if (in->module->cleanup)
		ret = in->module->cleanup((struct sr_input *)in);
	if (in->buf)
		g_string_free(in->buf, TRUE);
	g_free((gpointer)in);

	return ret;
}


/** @} */