[libsigrok.git] / src / output / wav.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 <config.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "output/wav"

/* Minimum/maximum number of samples per channel to put in a data chunk */
#define MIN_DATA_CHUNK_SAMPLES 10

struct out_context {
	double scale;
	gboolean header_done;
	uint64_t samplerate;
	int num_channels;
	GSList *channels;
	int chanbuf_size;
	int *chanbuf_used;
	uint8_t **chanbuf;
	float *fdata;
};

static int realloc_chanbufs(const struct sr_output *o, int size)
{
	struct out_context *outc;
	int i;

	outc = o->priv;
	for (i = 0; i < outc->num_channels; i++) {
		if (!(outc->chanbuf[i] = g_try_realloc(outc->chanbuf[i], sizeof(float) * size))) {
			sr_err("Unable to allocate enough output buffer memory.");
			return SR_ERR;
		}
		outc->chanbuf_used[i] = 0;
	}
	outc->chanbuf_size = size;

	return SR_OK;
}

static int flush_chanbufs(const struct sr_output *o, GString *out)
{
	struct out_context *outc;
	int num_samples, i, j;
	char *buf, *bufp;

	outc = o->priv;

	/* Any one of them will do. */
	num_samples = outc->chanbuf_used[0];
	if (!(buf = g_try_malloc(4 * num_samples * outc->num_channels))) {
		sr_err("Unable to allocate enough interleaved output buffer memory.");
		return SR_ERR;
	}

	bufp = buf;
	for (i = 0; i < num_samples; i++) {
		for (j = 0; j < outc->num_channels; j++) {
			memcpy(bufp, outc->chanbuf[j] + i * 4, 4);
			bufp += 4;
		}
	}
	g_string_append_len(out, buf, 4 * num_samples * outc->num_channels);
	g_free(buf);

	for (i = 0; i < outc->num_channels; i++)
		outc->chanbuf_used[i] = 0;

	return SR_OK;
}

static int init(struct sr_output *o, GHashTable *options)
{
	struct out_context *outc;
	struct sr_channel *ch;
	GSList *l;

	outc = g_malloc0(sizeof(struct out_context));
	o->priv = outc;
	outc->scale = g_variant_get_double(g_hash_table_lookup(options, "scale"));

	for (l = o->sdi->channels; l; l = l->next) {
		ch = l->data;
		if (ch->type != SR_CHANNEL_ANALOG)
			continue;
		if (!ch->enabled)
			continue;
		outc->channels = g_slist_append(outc->channels, ch);
		outc->num_channels++;
	}

	outc->chanbuf = g_malloc0(sizeof(float *) * outc->num_channels);
	outc->chanbuf_used = g_malloc0(sizeof(int) * outc->num_channels);

	/* Start off the interleaved buffer with 100 samples/channel. */
	realloc_chanbufs(o, 100);

	return SR_OK;
}

static void add_data_chunk(const struct sr_output *o, GString *gs)
{
	struct out_context *outc;
	char tmp[4];

	outc = o->priv;
	g_string_append(gs, "fmt ");
	/* Remaining chunk size */
	WL32(tmp, 0x12);
	g_string_append_len(gs, tmp, 4);
	/* Format code 3 = IEEE float */
	WL16(tmp, 0x0003);
	g_string_append_len(gs, tmp, 2);
	/* Number of channels */
	WL16(tmp, outc->num_channels);
	g_string_append_len(gs, tmp, 2);
	/* Samplerate */
	WL32(tmp, outc->samplerate);
	g_string_append_len(gs, tmp, 4);
	/* Byterate, using 32-bit floats. */
	WL32(tmp, outc->samplerate * outc->num_channels * 4);
	g_string_append_len(gs, tmp, 4);
	/* Blockalign */
	WL16(tmp, outc->num_channels * 4);
	g_string_append_len(gs, tmp, 2);
	/* Bits per sample */
	WL16(tmp, 32);
	g_string_append_len(gs, tmp, 2);
	WL16(tmp, 0);
	g_string_append_len(gs, tmp, 2);

	g_string_append(gs, "data");
	/* Data chunk size, max it out. */
	WL32(tmp, 0xffffffff);
	g_string_append_len(gs, tmp, 4);
}

static GString *gen_header(const struct sr_output *o)
{
	struct out_context *outc;
	GVariant *gvar;
	GString *header;
	char tmp[4];

	outc = o->priv;
	if (outc->samplerate == 0) {
		if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
				&gvar) == SR_OK) {
			outc->samplerate = g_variant_get_uint64(gvar);
			g_variant_unref(gvar);
		}
	}

	header = g_string_sized_new(512);
	g_string_append(header, "RIFF");
	/* Total size. Max out the field. */
	WL32(tmp, 0xffffffff);
	g_string_append_len(header, tmp, 4);
	g_string_append(header, "WAVE");
	add_data_chunk(o, header);

	return header;
}

/*
 * Stores the float in little-endian BINARY32 IEEE-754 2008 format.
 */
static void float_to_le(uint8_t *buf, float value)
{
	uint8_t *old;

	old = (uint8_t *)&value;
#ifdef WORDS_BIGENDIAN
	buf[0] = old[3];
	buf[1] = old[2];
	buf[2] = old[1];
	buf[3] = old[0];
#else
	buf[0] = old[0];
	buf[1] = old[1];
	buf[2] = old[2];
	buf[3] = old[3];
#endif
}

/*
 * Returns the number of samples used in the current channel buffers,
 * or -1 if they're not all the same.
 */
static int check_chanbuf_size(const struct sr_output *o)
{
	struct out_context *outc;
	int size, i;

	outc = o->priv;
	size = 0;
	for (i = 0; i < outc->num_channels; i++) {
		if (size == 0) {
			if (outc->chanbuf_used[i] == 0) {
				/* Nothing in all the buffers yet. */
				size = -1;
				break;
			} else {
				/* New high water mark. */
				size = outc->chanbuf_used[i];
			}
		} else if (outc->chanbuf_used[i] != size) {
			/* All channel buffers are not equally full yet. */
			size = -1;
			break;
		}
	}

	return size;
}

static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
		GString **out)
{
	struct out_context *outc;
	const struct sr_datafeed_meta *meta;
	const struct sr_datafeed_analog *analog;
	const struct sr_config *src;
	struct sr_channel *ch;
	GSList *l;
	const GSList *channels;
	float f;
	int num_channels, num_samples, size, *chan_idx, idx, i, j, ret;
	float *data;
	uint8_t *buf;

	*out = NULL;
	if (!o || !o->sdi || !(outc = o->priv))
		return SR_ERR_ARG;

	switch (packet->type) {
	case SR_DF_META:
		meta = packet->payload;
		for (l = meta->config; l; l = l->next) {
			src = l->data;
			if (src->key != SR_CONF_SAMPLERATE)
				continue;
			outc->samplerate = g_variant_get_uint64(src->data);
		}
		break;
	case SR_DF_ANALOG:
		if (!outc->header_done) {
			*out = gen_header(o);
			outc->header_done = TRUE;
		} else {
			*out = g_string_sized_new(512);
		}

		analog = packet->payload;
		num_samples = analog->num_samples;
		channels = analog->meaning->channels;
		num_channels = g_slist_length(analog->meaning->channels);
		if (!(data = g_try_realloc(outc->fdata, sizeof(float) * num_samples * num_channels)))
			return SR_ERR_MALLOC;
		outc->fdata = data;
		ret = sr_analog_to_float(analog, data);
		if (ret != SR_OK)
			return ret;

		if (num_samples == 0)
			return SR_OK;

		if (num_channels > outc->num_channels) {
			sr_err("Packet has %d channels, but only %d were enabled.",
					num_channels, outc->num_channels);
			return SR_ERR;
		}

		if (num_samples > outc->chanbuf_size) {
			if (realloc_chanbufs(o, analog->num_samples) != SR_OK)
				return SR_ERR_MALLOC;
		}

		/* Index the channels in this packet, so we can interleave quicker. */
		chan_idx = g_malloc(sizeof(int) * outc->num_channels);
		for (i = 0; i < num_channels; i++) {
			ch = g_slist_nth_data((GSList *) channels, i);
			chan_idx[i] = g_slist_index(outc->channels, ch);
		}

		for (i = 0; i < num_samples; i++) {
			for (j = 0; j < num_channels; j++) {
				idx = chan_idx[j];
				buf = outc->chanbuf[idx] + outc->chanbuf_used[idx]++ * 4;
				f = data[i * num_channels + j];
				if (outc->scale != 1.0)
					f /= outc->scale;
				float_to_le(buf, f);
			}
		}
		g_free(chan_idx);

		size = check_chanbuf_size(o);
		if (size > MIN_DATA_CHUNK_SAMPLES)
			if (flush_chanbufs(o, *out) != SR_OK)
				return SR_ERR;
		break;
	case SR_DF_END:
		size = check_chanbuf_size(o);
		if (size > 0) {
			*out = g_string_sized_new(4 * size * outc->num_channels);
			if (flush_chanbufs(o, *out) != SR_OK)
				return SR_ERR;
		}
		break;
	}

	return SR_OK;
}

static struct sr_option options[] = {
	{ "scale", "Scale", "Scale values by factor", NULL, NULL },
	ALL_ZERO
};

static const struct sr_option *get_options(void)
{
	if (!options[0].def)
		options[0].def = g_variant_ref_sink(g_variant_new_double(1.0));

	return options;
}

static int cleanup(struct sr_output *o)
{
	struct out_context *outc;
	int i;

	outc = o->priv;
	g_slist_free(outc->channels);
	g_variant_unref(options[0].def);
	for (i = 0; i < outc->num_channels; i++)
		g_free(outc->chanbuf[i]);
	g_free(outc->chanbuf_used);
	g_free(outc->chanbuf);
	g_free(outc->fdata);
	g_free(outc);
	o->priv = NULL;

	return SR_OK;
}

SR_PRIV struct sr_output_module output_wav = {
	.id = "wav",
	.name = "WAV",
	.desc = "Microsoft WAV file format data",
	.exts = (const char*[]){"wav", NULL},
	.flags = 0,
	.options = get_options,
	.init = init,
	.receive = receive,
	.cleanup = cleanup,
};
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
	5	*
	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.
	10	*
	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.
	15	*
	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/>.
	18	*/
	19
	20	#include <config.h>
	21	#include <string.h>
	22	#include <libsigrok/libsigrok.h>
	23	#include "libsigrok-internal.h"
	24
	25	#define LOG_PREFIX "output/wav"
	26
	27	/* Minimum/maximum number of samples per channel to put in a data chunk */
	28	#define MIN_DATA_CHUNK_SAMPLES 10
	29
	30	struct out_context {
	31	double scale;
	32	gboolean header_done;
	33	uint64_t samplerate;
	34	int num_channels;
	35	GSList *channels;
	36	int chanbuf_size;
	37	int *chanbuf_used;
	38	uint8_t **chanbuf;
	39	float *fdata;
	40	};
	41
	42	static int realloc_chanbufs(const struct sr_output *o, int size)
	43	{
	44	struct out_context *outc;
	45	int i;
	46
	47	outc = o->priv;
	48	for (i = 0; i < outc->num_channels; i++) {
	49	if (!(outc->chanbuf[i] = g_try_realloc(outc->chanbuf[i], sizeof(float) * size))) {
	50	sr_err("Unable to allocate enough output buffer memory.");
	51	return SR_ERR;
	52	}
	53	outc->chanbuf_used[i] = 0;
	54	}
	55	outc->chanbuf_size = size;
	56
	57	return SR_OK;
	58	}
	59
	60	static int flush_chanbufs(const struct sr_output o, GString out)
	61	{
	62	struct out_context *outc;
	63	int num_samples, i, j;
	64	char buf, bufp;
	65
	66	outc = o->priv;
	67
	68	/* Any one of them will do. */
	69	num_samples = outc->chanbuf_used[0];
	70	if (!(buf = g_try_malloc(4 * num_samples * outc->num_channels))) {
	71	sr_err("Unable to allocate enough interleaved output buffer memory.");
	72	return SR_ERR;
	73	}
	74
	75	bufp = buf;
	76	for (i = 0; i < num_samples; i++) {
	77	for (j = 0; j < outc->num_channels; j++) {
	78	memcpy(bufp, outc->chanbuf[j] + i * 4, 4);
	79	bufp += 4;
	80	}
	81	}
	82	g_string_append_len(out, buf, 4 * num_samples * outc->num_channels);
	83	g_free(buf);
	84
	85	for (i = 0; i < outc->num_channels; i++)
	86	outc->chanbuf_used[i] = 0;
	87
	88	return SR_OK;
	89	}
	90
	91	static int init(struct sr_output o, GHashTable options)
	92	{
	93	struct out_context *outc;
	94	struct sr_channel *ch;
	95	GSList *l;
	96
	97	outc = g_malloc0(sizeof(struct out_context));
	98	o->priv = outc;
	99	outc->scale = g_variant_get_double(g_hash_table_lookup(options, "scale"));
	100
	101	for (l = o->sdi->channels; l; l = l->next) {
	102	ch = l->data;
	103	if (ch->type != SR_CHANNEL_ANALOG)
	104	continue;
	105	if (!ch->enabled)
	106	continue;
	107	outc->channels = g_slist_append(outc->channels, ch);
	108	outc->num_channels++;
	109	}
	110
	111	outc->chanbuf = g_malloc0(sizeof(float ) outc->num_channels);
	112	outc->chanbuf_used = g_malloc0(sizeof(int) * outc->num_channels);
	113
	114	/* Start off the interleaved buffer with 100 samples/channel. */
	115	realloc_chanbufs(o, 100);
	116
	117	return SR_OK;
	118	}
	119
	120	static void add_data_chunk(const struct sr_output o, GString gs)
	121	{
	122	struct out_context *outc;
	123	char tmp[4];
	124
	125	outc = o->priv;
	126	g_string_append(gs, "fmt ");
	127	/* Remaining chunk size */
	128	WL32(tmp, 0x12);
	129	g_string_append_len(gs, tmp, 4);
	130	/* Format code 3 = IEEE float */
	131	WL16(tmp, 0x0003);
	132	g_string_append_len(gs, tmp, 2);
	133	/* Number of channels */
	134	WL16(tmp, outc->num_channels);
	135	g_string_append_len(gs, tmp, 2);
	136	/* Samplerate */
	137	WL32(tmp, outc->samplerate);
	138	g_string_append_len(gs, tmp, 4);
	139	/* Byterate, using 32-bit floats. */
	140	WL32(tmp, outc->samplerate * outc->num_channels * 4);
	141	g_string_append_len(gs, tmp, 4);
	142	/* Blockalign */
	143	WL16(tmp, outc->num_channels * 4);
	144	g_string_append_len(gs, tmp, 2);
	145	/* Bits per sample */
	146	WL16(tmp, 32);
	147	g_string_append_len(gs, tmp, 2);
	148	WL16(tmp, 0);
	149	g_string_append_len(gs, tmp, 2);
	150
	151	g_string_append(gs, "data");
	152	/* Data chunk size, max it out. */
	153	WL32(tmp, 0xffffffff);
	154	g_string_append_len(gs, tmp, 4);
	155	}
	156
	157	static GString gen_header(const struct sr_output o)
	158	{
	159	struct out_context *outc;
	160	GVariant *gvar;
	161	GString *header;
	162	char tmp[4];
	163
	164	outc = o->priv;
	165	if (outc->samplerate == 0) {
	166	if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
	167	&gvar) == SR_OK) {
	168	outc->samplerate = g_variant_get_uint64(gvar);
	169	g_variant_unref(gvar);
	170	}
	171	}
	172
	173	header = g_string_sized_new(512);
	174	g_string_append(header, "RIFF");
	175	/* Total size. Max out the field. */
	176	WL32(tmp, 0xffffffff);
	177	g_string_append_len(header, tmp, 4);
	178	g_string_append(header, "WAVE");
	179	add_data_chunk(o, header);
	180
	181	return header;
	182	}
	183
	184	/*
	185	* Stores the float in little-endian BINARY32 IEEE-754 2008 format.
	186	*/
	187	static void float_to_le(uint8_t *buf, float value)
	188	{
	189	uint8_t *old;
	190
	191	old = (uint8_t *)&value;
	192	#ifdef WORDS_BIGENDIAN
	193	buf[0] = old[3];
	194	buf[1] = old[2];
	195	buf[2] = old[1];
	196	buf[3] = old[0];
	197	#else
	198	buf[0] = old[0];
	199	buf[1] = old[1];
	200	buf[2] = old[2];
	201	buf[3] = old[3];
	202	#endif
	203	}
	204
	205	/*
	206	* Returns the number of samples used in the current channel buffers,
	207	* or -1 if they're not all the same.
	208	*/
	209	static int check_chanbuf_size(const struct sr_output *o)
	210	{
	211	struct out_context *outc;
	212	int size, i;
	213
	214	outc = o->priv;
	215	size = 0;
	216	for (i = 0; i < outc->num_channels; i++) {
	217	if (size == 0) {
	218	if (outc->chanbuf_used[i] == 0) {
	219	/* Nothing in all the buffers yet. */
	220	size = -1;
	221	break;
	222	} else {
	223	/* New high water mark. */
	224	size = outc->chanbuf_used[i];
	225	}
	226	} else if (outc->chanbuf_used[i] != size) {
	227	/* All channel buffers are not equally full yet. */
	228	size = -1;
	229	break;
	230	}
	231	}
	232
	233	return size;
	234	}
	235
	236	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
	237	GString **out)
	238	{
	239	struct out_context *outc;
	240	const struct sr_datafeed_meta *meta;
	241	const struct sr_datafeed_analog *analog;
	242	const struct sr_config *src;
	243	struct sr_channel *ch;
	244	GSList *l;
	245	const GSList *channels;
	246	float f;
	247	int num_channels, num_samples, size, *chan_idx, idx, i, j, ret;
	248	float *data;
	249	uint8_t *buf;
	250
	251	*out = NULL;
	252	if (!o \|\| !o->sdi \|\| !(outc = o->priv))
	253	return SR_ERR_ARG;
	254
	255	switch (packet->type) {
	256	case SR_DF_META:
	257	meta = packet->payload;
	258	for (l = meta->config; l; l = l->next) {
	259	src = l->data;
	260	if (src->key != SR_CONF_SAMPLERATE)
	261	continue;
	262	outc->samplerate = g_variant_get_uint64(src->data);
	263	}
	264	break;
	265	case SR_DF_ANALOG:
	266	if (!outc->header_done) {
	267	*out = gen_header(o);
	268	outc->header_done = TRUE;
	269	} else {
	270	*out = g_string_sized_new(512);
	271	}
	272
	273	analog = packet->payload;
	274	num_samples = analog->num_samples;
	275	channels = analog->meaning->channels;
	276	num_channels = g_slist_length(analog->meaning->channels);
	277	if (!(data = g_try_realloc(outc->fdata, sizeof(float) * num_samples * num_channels)))
	278	return SR_ERR_MALLOC;
	279	outc->fdata = data;
	280	ret = sr_analog_to_float(analog, data);
	281	if (ret != SR_OK)
	282	return ret;
	283
	284	if (num_samples == 0)
	285	return SR_OK;
	286
	287	if (num_channels > outc->num_channels) {
	288	sr_err("Packet has %d channels, but only %d were enabled.",
	289	num_channels, outc->num_channels);
	290	return SR_ERR;
	291	}
	292
	293	if (num_samples > outc->chanbuf_size) {
	294	if (realloc_chanbufs(o, analog->num_samples) != SR_OK)
	295	return SR_ERR_MALLOC;
	296	}
	297
	298	/* Index the channels in this packet, so we can interleave quicker. */
	299	chan_idx = g_malloc(sizeof(int) * outc->num_channels);
	300	for (i = 0; i < num_channels; i++) {
	301	ch = g_slist_nth_data((GSList *) channels, i);
	302	chan_idx[i] = g_slist_index(outc->channels, ch);
	303	}
	304
	305	for (i = 0; i < num_samples; i++) {
	306	for (j = 0; j < num_channels; j++) {
	307	idx = chan_idx[j];
	308	buf = outc->chanbuf[idx] + outc->chanbuf_used[idx]++ * 4;
	309	f = data[i * num_channels + j];
	310	if (outc->scale != 1.0)
	311	f /= outc->scale;
	312	float_to_le(buf, f);
	313	}
	314	}
	315	g_free(chan_idx);
	316
	317	size = check_chanbuf_size(o);
	318	if (size > MIN_DATA_CHUNK_SAMPLES)
	319	if (flush_chanbufs(o, *out) != SR_OK)
	320	return SR_ERR;
	321	break;
	322	case SR_DF_END:
	323	size = check_chanbuf_size(o);
	324	if (size > 0) {
	325	out = g_string_sized_new(4 size * outc->num_channels);
	326	if (flush_chanbufs(o, *out) != SR_OK)
	327	return SR_ERR;
	328	}
	329	break;
	330	}
	331
	332	return SR_OK;
	333	}
	334
	335	static struct sr_option options[] = {
	336	{ "scale", "Scale", "Scale values by factor", NULL, NULL },
	337	ALL_ZERO
	338	};
	339
	340	static const struct sr_option *get_options(void)
	341	{
	342	if (!options[0].def)
	343	options[0].def = g_variant_ref_sink(g_variant_new_double(1.0));
	344
	345	return options;
	346	}
	347
	348	static int cleanup(struct sr_output *o)
	349	{
	350	struct out_context *outc;
	351	int i;
	352
	353	outc = o->priv;
	354	g_slist_free(outc->channels);
	355	g_variant_unref(options[0].def);
	356	for (i = 0; i < outc->num_channels; i++)
	357	g_free(outc->chanbuf[i]);
	358	g_free(outc->chanbuf_used);
	359	g_free(outc->chanbuf);
	360	g_free(outc->fdata);
	361	g_free(outc);
	362	o->priv = NULL;
	363
	364	return SR_OK;
	365	}
	366
	367	SR_PRIV struct sr_output_module output_wav = {
	368	.id = "wav",
	369	.name = "WAV",
	370	.desc = "Microsoft WAV file format data",
	371	.exts = (const char*[]){"wav", NULL},
	372	.flags = 0,
	373	.options = get_options,
	374	.init = init,
	375	.receive = receive,
	376	.cleanup = cleanup,
	377	};