/** Sample value remapping for mux.
 *
 * @file
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @copyright 2017-2018, Institute for Automation of Complex Power Systems, EONERC
 * @license GNU General Public License (version 3)
 *
 * VILLASnode
 *
 * 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
 * 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/>.
 *********************************************************************************/

#pragma once

#include <jansson.h>

#include <villas/stats.h>
#include <villas/common.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Forward declarations */
struct node;
struct sample;
struct signal;
struct list;

enum mapping_type {
	MAPPING_TYPE_DATA,
	MAPPING_TYPE_STATS,
	MAPPING_TYPE_HEADER,
	MAPPING_TYPE_TIMESTAMP
};

enum mapping_stats_type {
	MAPPING_STATS_TYPE_LAST,
	MAPPING_STATS_TYPE_HIGHEST,
	MAPPING_STATS_TYPE_LOWEST,
	MAPPING_STATS_TYPE_MEAN,
	MAPPING_STATS_TYPE_VAR,
	MAPPING_STATS_TYPE_STDDEV,
	MAPPING_STATS_TYPE_TOTAL
};

enum mapping_header_type {
	MAPPING_HEADER_TYPE_LENGTH,
	MAPPING_HEADER_TYPE_SEQUENCE
};

enum mapping_timestamp_type {
	MAPPING_TIMESTAMP_TYPE_ORIGIN,
	MAPPING_TIMESTAMP_TYPE_RECEIVED
};

struct mapping_entry {
	struct node *node;		/**< The node to which this mapping refers. */

	enum mapping_type type;		/**< The mapping type. Selects one of the union fields below. */

	/** The number of values which is covered by this mapping entry.
	 *
	 * A value of 0 indicates that all remaining values starting from the offset of a sample should be mapped.
	 */
	int length;
	int offset;			/**< Offset of this mapping entry within sample::data */

	union {
		struct {
			int offset;
			struct signal *signal;
		} data;

		struct {
			enum stats_id id;
			enum mapping_stats_type type;
		} stats;

		struct {
			enum mapping_header_type type;
		} header;

		struct {
			enum mapping_timestamp_type type;
		} timestamp;
	};
};

int mapping_remap(const struct list *m, struct sample *remapped, const struct sample *original, const struct stats *s);

int mapping_update(const struct mapping_entry *e, struct sample *remapped, const struct sample *original, const struct stats *s);

int mapping_parse(struct mapping_entry *e, json_t *cfg, struct list *nodes);

int mapping_parse_str(struct mapping_entry *e, const char *str, struct list *nodes);

int mapping_parse_list(struct list *l, json_t *cfg, struct list *nodes);

int mapping_to_str(const struct mapping_entry *me, unsigned index, char **str);

#ifdef __cplusplus
}
#endif